{"items":[{"type":"link","label":"Revenue API Reference","link":"/other-api/revenue-api-3.0","routeSlug":"/other-api/revenue-api-3.0","content":{"contentType":"overview","meta":{"name":"Revenue API Reference"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"revenue-api-3.0.json","url":"/_bundle/other-api/revenue-api-3.0.json?download"},{"kind":"download","label":"revenue-api-3.0.yaml","url":"/_bundle/other-api/revenue-api-3.0.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"cURL","lang":"curl"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Revenue API Reference (2026-10-16)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/other-api/revenue-api-3.0"}],"sectionId":"/other-api/revenue-api-3.0"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/introduction"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Introduction"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Welcome to the reference for Zuora Revenue REST API!"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REST is a web-service protocol that lends itself to rapid development by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"using everyday HTTP and JSON technology. Zuora Revenue provides various REST"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APIs for data integration. Use these REST APIs to authenticate and integrate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data from the source ERP systems with Zuora Revenue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All Zuora Revenue REST APIs are secured by using HTTPS. The authentication scheme is token-based authentication,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which means an authenticated user must generate a token and then use it for all subsequent APIs until the token expires."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This reference provides detailed descriptions about functions, requests, and responses of each REST API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Revenue REST APIs can be broadly classified into the following categories:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inbound"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outbound"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remember:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API service must be enabled for your tenant in the first place. Otherwise, the 405 error will be returned for every API request you submitted. To enable the API service, contact Zuora Revenue Support."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Both the inbound and outbound operations require an authentication token to perform integration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can obtain the token by using the Authentication operation."},"children":[]}]}]}]}]}]}],"sectionId":"/other-api/revenue-api-3.0/section/introduction"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/introduction/endpoints"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoints"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the APIs are provisioned in Zuora Revenue Cloud, you can get the endpoint and use that endpoint to call the APIs."},"children":[]}]}]}]}],"sectionId":"/other-api/revenue-api-3.0/section/introduction/endpoints"}],"sectionId":"/other-api/revenue-api-3.0/section/introduction/endpoints"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/introduction/requirements"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requirements"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before you use the Zuora Revenue APIs, make sure the following requirements are met:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Revenue uses role based access control to restrict system access to authorized users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use the Zuora Revenue APIs, make sure that your user role has the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webservices Inbound"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webservices Outbound"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" previleges in Zuora Revenue security settings. For more information,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-user-mgmt-access","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage User Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use the inbound operations to upload data into Zuora Revenue, the upload templates must be created by using the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File Upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" menu options in the Zuora Revenue UI."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently, the APIs support transaction upload, bundle upload, and event upload."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use the outbound operations, the outbound GL interface mapping must be set up in the Zuora Revenue UI ("},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setups > Application > Interface Setup"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}]}],"sectionId":"/other-api/revenue-api-3.0/section/introduction/requirements"}],"sectionId":"/other-api/revenue-api-3.0/section/introduction/requirements"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/introduction/requests-and-responses"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requests and Responses"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora Revenue APIs support the JSON format of HTTP responses. Inbound operations for data upload support the CSV format only."},"children":[]}]}]}]}],"sectionId":"/other-api/revenue-api-3.0/section/introduction/requests-and-responses"}],"sectionId":"/other-api/revenue-api-3.0/section/introduction/requests-and-responses"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/introduction/inbound-data-error"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inbound Data Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All the inbound data into Zuora Revenue are first loaded into pre-stage tables, namely CUST_UI tables in Zuora Revenue,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and then pushed to the corresponding staging tables from CUST_UI tables."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the data fails in the CUST_UI tables, the entire batch of records will be marked as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Failed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It means All or Nothing approach will be followed when data is being inserted to the CUST_UI tables."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the data has been successfully inserted into the CUST_UI tables, it will then be automatically pushed to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the staging tables and no manual work is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any uncollected data that remains in the staging tables can be manually fixed or downloaded, and can be reposted from the upstream systems."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use the Stage Error operations to retrieve error information about the uploaded data."},"children":[]}]}]}]}],"sectionId":"/other-api/revenue-api-3.0/section/introduction/inbound-data-error"}],"sectionId":"/other-api/revenue-api-3.0/section/introduction/inbound-data-error"}]}]}},{"type":"group","label":"Introduction","link":"/other-api/revenue-api-3.0/section/introduction","routeSlug":"/other-api/revenue-api-3.0/section/introduction","items":[{"type":"link","label":"Endpoints","link":"/other-api/revenue-api-3.0/section/introduction/endpoints","routeSlug":"/other-api/revenue-api-3.0/section/introduction/endpoints","content":null},{"type":"link","label":"Requirements","link":"/other-api/revenue-api-3.0/section/introduction/requirements","routeSlug":"/other-api/revenue-api-3.0/section/introduction/requirements","content":null},{"type":"link","label":"Requests and Responses","link":"/other-api/revenue-api-3.0/section/introduction/requests-and-responses","routeSlug":"/other-api/revenue-api-3.0/section/introduction/requests-and-responses","content":null},{"type":"link","label":"Inbound Data Error","link":"/other-api/revenue-api-3.0/section/introduction/inbound-data-error","routeSlug":"/other-api/revenue-api-3.0/section/introduction/inbound-data-error","content":null}],"content":null},{"type":"separator","label":"Authentication","content":null},{"type":"group","label":"Authentication","link":"/other-api/revenue-api-3.0/authentication","routeSlug":"/other-api/revenue-api-3.0/authentication","items":[{"label":"Create authentication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/authentication/post_authenticate","routeSlug":"/other-api/revenue-api-3.0/authentication/post_authenticate","metadata":{"seo":{"title":"Create authentication","description":"Authenticates and gets the Json Web Token to push and pull data from your Zuora Revenue instance."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_Authenticate","name":"Create authentication","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1authenticate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create authentication","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Authenticates and gets the Json Web Token to push and pull data from your Zuora Revenue instance.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"role","in":"header","schemaId":"schema_0","required":true},{"name":"clientname","in":"header","schemaId":"schema_1","required":true}],"pointer":"/paths/~1api~1integration~1v1~1authenticate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/integration/v1/authenticate","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"role","in":"header","required":true,"schemaId":"schema_0"},{"name":"clientname","in":"header","required":true,"schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/integration/v1/authenticate","href":"authentication/post_authenticate","openApiOperationId":"POST_Authenticate","summary":"Create authentication"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Authentication token is returned.","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_2"}},"schemaId":"schema_2"}],"pointer":"/paths/~1api~1integration~1v1~1authenticate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_2"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authentication/post_authenticate"}],"panels":[]}]},"httpPath":"/api/integration/v1/authenticate"}],"content":{"contentType":"group","meta":{"name":"Authentication"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authentication","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Authentication operation is the authentication layer when you integrate"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"data with Zuora Revenue APIs. Use this operation to authenticate and generate a token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that can be valid for a specific time period. The token is required for all the subsequent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API calls. By default, a token will be valid for 30 minutes before it expires. If the issued"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"token expires, call this operation again with valid credentials to get a new token."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To acquire the token, you must provide the user role and client name as well as basic"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authorization in the HTTP request header. An example of basic authorization header is as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Basic c3lzYWRtaW46fsDFsgsV2cHJvJTEyMw=="},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An example of the returned authentication token is as follows:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"ybmFtZSI6InZpbm90aC5iYWFsYWppIiwiaXNzIjoiUkV```\n","language":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2V"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"ybmFtZSI6InZpbm90aC5iYWFsYWppIiwiaXNzIjoiUkV```\n"},"children":[]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/integration/v1/authenticate","summary":"Create authentication","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authentication/post_authenticate","deprecated":false}]}]}]}]}},{"type":"separator","label":"Data Ingestion File Uploads","content":null},{"type":"group","label":"Adapter","link":"/other-api/revenue-api-3.0/adapter","routeSlug":"/other-api/revenue-api-3.0/adapter","items":[{"label":"List upload field mappings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/adapter/get_fileuploadmapping","routeSlug":"/other-api/revenue-api-3.0/adapter/get_fileuploadmapping","metadata":{"seo":{"title":"List upload field mappings","description":"Gets the field mapping information in the upload template definitions for transactions, events, or bundle configuration from Zuora Revenue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_FileUploadMapping","name":"List upload field mappings","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1upload~1mapping/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List upload field mappings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the field mapping information in the upload template definitions for transactions, events, or bundle configuration from Zuora Revenue."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"templatename","in":"query","schemaId":"schema_3","description":"Name of the upload template that contains the field mapping information."}],"pointer":"/paths/~1api~1integration~1v1~1upload~1mapping/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"token","in":"header","schemaId":"schema_3","description":"The valid authentication token that is generated by the Authentication operation.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1upload~1mapping/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v1/upload/mapping","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[],"query":[{"name":"templatename","in":"query","schemaId":"schema_3"}],"querystring":[],"header":[{"name":"token","in":"header","required":true,"schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/integration/v1/upload/mapping","href":"adapter/get_fileuploadmapping","openApiOperationId":"GET_FileUploadMapping","summary":"List upload field mappings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Field mapping data is returned.","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_4"}},"schemaId":"schema_4"},{"code":"400","description":"Error fetching the mapping details."}],"pointer":"/paths/~1api~1integration~1v1~1upload~1mapping/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_4","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_4"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/adapter/get_fileuploadmapping"}],"panels":[]}]},"httpPath":"/api/integration/v1/upload/mapping"}],"content":{"contentType":"group","meta":{"name":"Adapter"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adapter","showPageActions":true},{"nodeType":"markdoc","content":"The Adapter operation is used to retrieve field mapping information in an upload template definitions. The field mapping information determines the mapping between the staging field names and the label names in the upload file."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/integration/v1/upload/mapping","summary":"List upload field mappings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/adapter/get_fileuploadmapping","deprecated":false}]}]}]}]}},{"type":"group","label":"File Upload","link":"/other-api/revenue-api-3.0/file-upload","routeSlug":"/other-api/revenue-api-3.0/file-upload","items":[{"label":"Retrieve the file upload status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/file-upload/get_fileuploadstatus","routeSlug":"/other-api/revenue-api-3.0/file-upload/get_fileuploadstatus","metadata":{"seo":{"title":"Retrieve the file upload status","description":"Gets the status information about the specified file upload request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_FileUploadStatus","name":"Retrieve the file upload status","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1fileupload~1status~1{file_request_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the file upload status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the status information about the specified file upload request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"file_request_id","in":"path","schemaId":"schema_5","description":"The request ID of the file upload to be queried.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1fileupload~1status~1{file_request_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"token","in":"header","schemaId":"schema_3","description":"The valid authentication token that is generated by the Authentication operation.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1fileupload~1status~1{file_request_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v1/fileupload/status/{file_request_id}","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[{"name":"file_request_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"token","in":"header","required":true,"schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","204"],"pointer":"/api/integration/v1/fileupload/status/{file_request_id}","href":"file-upload/get_fileuploadstatus","openApiOperationId":"GET_FileUploadStatus","summary":"Retrieve the file upload status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The status information is returned for the requested file upload.","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_6"}},"schemaId":"schema_6"},{"code":"204","description":"The status information cannot be retrieved for the specified request ID."}],"pointer":"/paths/~1api~1integration~1v1~1fileupload~1status~1{file_request_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_6","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_6"}}},{"code":"204"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-upload/get_fileuploadstatus"}],"panels":[]}]},"httpPath":"/api/integration/v1/fileupload/status/{file_request_id}"},{"label":"Upload file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/file-upload/post_uploadfile","routeSlug":"/other-api/revenue-api-3.0/file-upload/post_uploadfile","metadata":{"seo":{"title":"Upload file","description":"Upload the event or transaction data in a CSV file to Zuora Revenue in UTF-8."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_UploadFile","name":"Upload file","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1upload~1file/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload the event or transaction data in a CSV file to Zuora Revenue in UTF-8."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It is recommended to have up to 60k lines per request in this operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"token","in":"header","schemaId":"schema_3","description":"The valid authentication token that is generated by the Authentication operation.","required":true},{"name":"templatename","in":"header","schemaId":"schema_3","description":"Name of the upload template that you want to use.","required":true},{"name":"Content-Type","in":"header","schemaId":"schema_7","description":"Must be set to \"multipart/form-data\".","required":true}],"pointer":"/paths/~1api~1integration~1v1~1upload~1file/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_8"}},"schemaId":"schema_8","pointer":"/paths/~1api~1integration~1v1~1upload~1file/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/integration/v1/upload/file","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"token","in":"header","required":true,"schemaId":"schema_3"},{"name":"templatename","in":"header","required":true,"schemaId":"schema_3"},{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_7"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_8"}},"responseCodes":["200","400"],"pointer":"/api/integration/v1/upload/file","href":"file-upload/post_uploadfile","openApiOperationId":"POST_UploadFile","summary":"Upload file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"schemaId":"schema_8","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_8"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The file is uploaded to Zuora Revenue.","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_9"}},"schemaId":"schema_9"},{"code":"400","description":"Exception occurs. Please contact Zuora Revenue Support.","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_10"}},"schemaId":"schema_10"}],"pointer":"/paths/~1api~1integration~1v1~1upload~1file/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_9","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_9"}}},{"code":"400","schemaId":"schema_10","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_10"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/file-upload/post_uploadfile"}],"panels":[]}]},"httpPath":"/api/integration/v1/upload/file"}],"content":{"contentType":"group","meta":{"name":"File Upload"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"File Upload","showPageActions":true},{"nodeType":"markdoc","content":"The File Upload operations are used to upload large volumes of data as a CSV file in the HTTP body to Zuora Revenue and to get status information about the file upload.\n\nIf the data volume is in the range of 40k-60k records per file per request, the Upload file operation can process  the data quickly. \nA unique request ID is generated after the file is successfully received, which can be used  to query the upload status in the Get file upload status operation."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/integration/v1/fileupload/status/{file_request_id}","summary":"Retrieve the file upload status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/file-upload/get_fileuploadstatus","deprecated":false},{"title":"/api/integration/v1/upload/file","summary":"Upload file","prefix":{"name":"post","color":"post"},"badges":[],"link":"/file-upload/post_uploadfile","deprecated":false}]}]}]}]}},{"type":"group","label":"Inbound","link":"/other-api/revenue-api-3.0/inbound","routeSlug":"/other-api/revenue-api-3.0/inbound","items":[{"label":"Retrieve the upload status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/inbound/get_uploadstatus","routeSlug":"/other-api/revenue-api-3.0/inbound/get_uploadstatus","metadata":{"seo":{"title":"Retrieve the upload status","description":"Gets the status information about the Create upload operation."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_UploadStatus","name":"Retrieve the upload status","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1csv~1upload~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the upload status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the status information about the Create upload operation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_5","description":"The request ID of the uploaded file for which the status information is being queried.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1csv~1upload~1status/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"token","in":"header","schemaId":"schema_3","description":"The valid authentication token that is generated by the Authentication operation.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1csv~1upload~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v1/csv/upload/status","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[],"query":[{"name":"id","in":"query","required":true,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"token","in":"header","required":true,"schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/integration/v1/csv/upload/status","href":"inbound/get_uploadstatus","openApiOperationId":"GET_UploadStatus","summary":"Retrieve the upload status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The status information is returned for the requested upload.","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_11"}},"schemaId":"schema_11"},{"code":"400","description":"The status information cannot be retrieved for the specified request ID.","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_12"}},"schemaId":"schema_12"}],"pointer":"/paths/~1api~1integration~1v1~1csv~1upload~1status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_11","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_11"}}},{"code":"400","schemaId":"schema_12","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_12"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbound/get_uploadstatus"}],"panels":[]}]},"httpPath":"/api/integration/v1/csv/upload/status"},{"label":"Create upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/inbound/post_upload","routeSlug":"/other-api/revenue-api-3.0/inbound/post_upload","metadata":{"seo":{"title":"Create upload","description":"Uploads the transaction, events, or bundle configuration data as a CSV (text/plain) file with UTF-8 encoding."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_Upload","name":"Create upload","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1csv~1upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploads the transaction, events, or bundle configuration data as a CSV (text/plain) file with UTF-8 encoding."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Up to 20k lines per request can be supported by this operation. If the CSV file contains more than 20k lines, it is recommended to use the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/other-api/revenue/operation/POST_UploadFile"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload file"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"token","in":"header","schemaId":"schema_3","description":"The valid authentication token that is generated by the Authentication operation.","required":true},{"name":"templatename","in":"header","schemaId":"schema_3","description":"The name of the upload template that you want to use.","required":true},{"name":"filename","in":"header","schemaId":"schema_3","description":"The unique file name to populate the data in the Zuora Revenue UI.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1csv~1upload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["text/plain"],"mediaTypeSchemas":{"text/plain":{"schemaId":"schema_13"}},"schemaId":"schema_13","pointer":"/paths/~1api~1integration~1v1~1csv~1upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/integration/v1/csv/upload","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"token","in":"header","required":true,"schemaId":"schema_3"},{"name":"templatename","in":"header","required":true,"schemaId":"schema_3"},{"name":"filename","in":"header","required":true,"schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"text/plain":{"schemaId":"schema_13"}},"responseCodes":["200","400"],"pointer":"/api/integration/v1/csv/upload","href":"inbound/post_upload","openApiOperationId":"POST_Upload","summary":"Create upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"schemaId":"schema_13","mediaTypes":["text/plain"],"mediaTypeSchemas":{"text/plain":{"schemaId":"schema_13"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Data is uploaded to the staging tables in Zuora Revenue.","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_14"}},"schemaId":"schema_14"},{"code":"400","description":"Error occurs when data is being uploaded to Zuora Revenue staging tables.","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_15"}},"schemaId":"schema_15"}],"pointer":"/paths/~1api~1integration~1v1~1csv~1upload/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_14","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_14"}}},{"code":"400","schemaId":"schema_15","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_15"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbound/post_upload"}],"panels":[]}]},"httpPath":"/api/integration/v1/csv/upload"}],"content":{"contentType":"group","meta":{"name":"Inbound"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inbound","showPageActions":true},{"nodeType":"markdoc","content":"The Inbound operations are used to upload data in the CSV format to Zuora Revenue. As a prerequisite,  the upload template definitions must be present in Zuora Revenue. Then, you specify the template name,  file name, authentication token, and the CSV data in HTTP body of the inbound operations to upload data. It is recommended to use the Create upload operation for the CSV file than contains less than 20k lines. \n\nAfter the data is uploaded to the pre-stage table, Zuora Revenue scheduler will load the CSV content to corresponding staging tables in Zuora Revenue. You can query the upload status by using the Get upload status operation."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/integration/v1/csv/upload/status","summary":"Retrieve the upload status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbound/get_uploadstatus","deprecated":false},{"title":"/api/integration/v1/csv/upload","summary":"Create upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inbound/post_upload","deprecated":false}]}]}]}]}},{"type":"separator","label":"Staging Errors","content":null},{"type":"group","label":"Stage Error","link":"/other-api/revenue-api-3.0/stage-error","routeSlug":"/other-api/revenue-api-3.0/stage-error","items":[{"label":"List staging errors","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/stage-error/get_staggingerror","routeSlug":"/other-api/revenue-api-3.0/stage-error/get_staggingerror","metadata":{"seo":{"title":"List staging errors","description":"Gets the information about transaction staging errors or event staging errors."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_StaggingError","name":"List staging errors","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1stage~1error~1{errortype}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List staging errors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the information about transaction staging errors or event staging errors."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"errortype","in":"path","schemaId":"schema_16","description":"The type of errors that you want to retrieve.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1stage~1error~1{errortype}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"token","in":"header","schemaId":"schema_3","description":"The valid authentication token that is generated by the Authentication operation.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1stage~1error~1{errortype}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v1/stage/error/{errortype}","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[{"name":"errortype","in":"path","required":true,"schemaId":"schema_16"}],"query":[],"querystring":[],"header":[{"name":"token","in":"header","required":true,"schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","204"],"pointer":"/api/integration/v1/stage/error/{errortype}","href":"stage-error/get_staggingerror","openApiOperationId":"GET_StaggingError","summary":"List staging errors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Staging errors of the specified type are returned.","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_17"}},"schemaId":"schema_17"},{"code":"204","description":"No record is found for the error type specified in the path parameter."}],"pointer":"/paths/~1api~1integration~1v1~1stage~1error~1{errortype}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_17","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_17"}}},{"code":"204"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stage-error/get_staggingerror"}],"panels":[]}]},"httpPath":"/api/integration/v1/stage/error/{errortype}"}],"content":{"contentType":"group","meta":{"name":"Stage Error"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stage Error","showPageActions":true},{"nodeType":"markdoc","content":"The Stage Error operation is used to get the list of records that contain errors in the Zuora Revenue staging tables for transactions or events."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/integration/v1/stage/error/{errortype}","summary":"List staging errors","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stage-error/get_staggingerror","deprecated":false}]}]}]}]}},{"type":"separator","label":"Revenue Transfer Accounting","content":null},{"type":"group","label":"Transfer Accounting","link":"/other-api/revenue-api-3.0/transfer-accounting","routeSlug":"/other-api/revenue-api-3.0/transfer-accounting","items":[{"label":"Update transfer batch status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/transfer-accounting/put_transferbatchstatus","routeSlug":"/other-api/revenue-api-3.0/transfer-accounting/put_transferbatchstatus","metadata":{"seo":{"title":"Update transfer batch status","description":"Updates the transfer batch status to Transferred in Zuora Revenue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT_TransferBatchStatus","name":"Update transfer batch status","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1journal~1batch~1status~1{batch_id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update transfer batch status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the transfer batch status to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transferred"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in Zuora Revenue."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"batch_id","in":"path","schemaId":"schema_5","description":"The batch ID of the transfer accounting batch.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1journal~1batch~1status~1{batch_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"token","in":"header","schemaId":"schema_3","description":"The valid authentication token that is generated by the Authentication operation.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1journal~1batch~1status~1{batch_id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/integration/v1/journal/batch/status/{batch_id}","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[{"name":"batch_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"token","in":"header","required":true,"schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/integration/v1/journal/batch/status/{batch_id}","href":"transfer-accounting/put_transferbatchstatus","openApiOperationId":"PUT_TransferBatchStatus","summary":"Update transfer batch status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the transfer batch is changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transferred"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_18"}},"schemaId":"schema_18"},{"code":"400","description":"Only the batch in Ready TO Transfer status can be updated.","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_19"}},"schemaId":"schema_19"}],"pointer":"/paths/~1api~1integration~1v1~1journal~1batch~1status~1{batch_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_18","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_18"}}},{"code":"400","schemaId":"schema_19","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_19"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer-accounting/put_transferbatchstatus"}],"panels":[]}]},"httpPath":"/api/integration/v1/journal/batch/status/{batch_id}"},{"label":"Retrieve a transfer batch","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/transfer-accounting/get_transferbatch","routeSlug":"/other-api/revenue-api-3.0/transfer-accounting/get_transferbatch","metadata":{"seo":{"title":"Retrieve a transfer batch","description":"Downloads the general ledger (GL) transfer batch data for the specified batch ID and page number.For more information, see Best practice for using Revenue APIs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_TransferBatch","name":"Retrieve a transfer batch","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1journal~1batch~1{batchid}~1{pagenum}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a transfer batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Downloads the general ledger (GL) transfer batch data for the specified batch ID and page number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-api-best-practice","target":"_blank"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Best practice for using Revenue APIs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"batchid","in":"path","schemaId":"schema_5","description":"The batch ID of the transfer accounting batch.","required":true},{"name":"pagenum","in":"path","schemaId":"schema_5","description":"The number of page to be downloaded.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1journal~1batch~1{batchid}~1{pagenum}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pagesize","in":"query","schemaId":"schema_5","description":"The number of records to be downloaded per request. The default is 1000 and the maximum is 10000."}],"pointer":"/paths/~1api~1integration~1v1~1journal~1batch~1{batchid}~1{pagenum}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"token","in":"header","schemaId":"schema_3","description":"The valid authentication token that is generated by the Authentication operation.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1journal~1batch~1{batchid}~1{pagenum}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v1/journal/batch/{batchid}/{pagenum}","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[{"name":"batchid","in":"path","required":true,"schemaId":"schema_5"},{"name":"pagenum","in":"path","required":true,"schemaId":"schema_5"}],"query":[{"name":"pagesize","in":"query","schemaId":"schema_5"}],"querystring":[],"header":[{"name":"token","in":"header","required":true,"schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/api/integration/v1/journal/batch/{batchid}/{pagenum}","href":"transfer-accounting/get_transferbatch","openApiOperationId":"GET_TransferBatch","summary":"Retrieve a transfer batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Operation is successful.","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_18"}},"schemaId":"schema_18"}],"pointer":"/paths/~1api~1integration~1v1~1journal~1batch~1{batchid}~1{pagenum}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_18","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_18"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer-accounting/get_transferbatch"}],"panels":[]}]},"httpPath":"/api/integration/v1/journal/batch/{batchid}/{pagenum}"},{"label":"List transfer batches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/transfer-accounting/get_transferbatchlist","routeSlug":"/other-api/revenue-api-3.0/transfer-accounting/get_transferbatchlist","metadata":{"seo":{"title":"List transfer batches","description":"Gets a list of the transfer accounting batches that are available in Zuora Revenue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_TransferBatchList","name":"List transfer batches","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1journal~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List transfer batches","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets a list of the transfer accounting batches that are available in Zuora Revenue."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"token","in":"header","schemaId":"schema_3","description":"The valid authentication token that is generated by the Authentication operation.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1journal~1list/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v1/journal/list","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"token","in":"header","required":true,"schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","204","400"],"pointer":"/api/integration/v1/journal/list","href":"transfer-accounting/get_transferbatchlist","openApiOperationId":"GET_TransferBatchList","summary":"List transfer batches"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Operation is successful.","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_20"}},"schemaId":"schema_20"},{"code":"204","description":"No GL Transfer batches in Ready to Transfer status are available."},{"code":"400","description":"Error occurs when fetching the GL batch list."}],"pointer":"/paths/~1api~1integration~1v1~1journal~1list/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_20","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_20"}}},{"code":"204"},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer-accounting/get_transferbatchlist"}],"panels":[]}]},"httpPath":"/api/integration/v1/journal/list"}],"content":{"contentType":"group","meta":{"name":"Transfer Accounting"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer Accounting","showPageActions":true},{"nodeType":"markdoc","content":"The Transfer Accounting operations are used to support outbound data integrations. You  can use these operations to query the transfer batch information and to update the transfer batch status."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/integration/v1/journal/batch/status/{batch_id}","summary":"Update transfer batch status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/transfer-accounting/put_transferbatchstatus","deprecated":false},{"title":"/api/integration/v1/journal/batch/{batchid}/{pagenum}","summary":"Retrieve a transfer batch","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfer-accounting/get_transferbatch","deprecated":false},{"title":"/api/integration/v1/journal/list","summary":"List transfer batches","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfer-accounting/get_transferbatchlist","deprecated":false}]}]}]}]}},{"type":"group","label":"Transfer Accounting Files","link":"/other-api/revenue-api-3.0/transfer-accounting-files","routeSlug":"/other-api/revenue-api-3.0/transfer-accounting-files","items":[{"label":"Download a transfer batch file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/transfer-accounting-files/get_transferbatchfile","routeSlug":"/other-api/revenue-api-3.0/transfer-accounting-files/get_transferbatchfile","metadata":{"seo":{"title":"Download a transfer batch file","description":"Downloads the GL transfer batch files from Zuora Revenue for the specified batch ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_TransferBatchFile","name":"Download a transfer batch file","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1download~1transferbatchfile~1{batch_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a transfer batch file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Downloads the GL transfer batch files from Zuora Revenue for the specified batch ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the transfer accounting files that are created in the last 48 hours are available for download."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum downloadable file size is 1 GB."},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"batch_id","in":"path","schemaId":"schema_5","description":"The batch ID of the transfer accounting batch.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1download~1transferbatchfile~1{batch_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"token","in":"header","schemaId":"schema_3","description":"The valid authentication token that is generated by the Authentication operation.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1download~1transferbatchfile~1{batch_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v1/download/transferbatchfile/{batch_id}","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[{"name":"batch_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"token","in":"header","required":true,"schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","204"],"pointer":"/api/integration/v1/download/transferbatchfile/{batch_id}","href":"transfer-accounting-files/get_transferbatchfile","openApiOperationId":"GET_TransferBatchFile","summary":"Download a transfer batch file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Operation is successful.","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_21"}},"schemaId":"schema_21"},{"code":"204","description":"The batch file is not generated for the batch ID or the batch file is not found."}],"pointer":"/paths/~1api~1integration~1v1~1download~1transferbatchfile~1{batch_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_21","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"schema_21"}}},{"code":"204"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer-accounting-files/get_transferbatchfile"}],"panels":[]}]},"httpPath":"/api/integration/v1/download/transferbatchfile/{batch_id}"}],"content":{"contentType":"group","meta":{"name":"Transfer Accounting Files"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer Accounting Files","showPageActions":true},{"nodeType":"markdoc","content":"The Transfer Accounting Files operation is used to download the transfer accounting  data in a CSV file from Zuora Revenue for a specific transfer batch."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/integration/v1/download/transferbatchfile/{batch_id}","summary":"Download a transfer batch file","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfer-accounting-files/get_transferbatchfile","deprecated":false}]}]}]}]}},{"type":"separator","label":"Revenue Jobs and Programs","content":null},{"type":"group","label":"Revenue Jobs","link":"/other-api/revenue-api-3.0/revenue-jobs","routeSlug":"/other-api/revenue-api-3.0/revenue-jobs","items":[{"label":"List available programs and program parameters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-jobs/get_programdetails","routeSlug":"/other-api/revenue-api-3.0/revenue-jobs/get_programdetails","metadata":{"seo":{"title":"List available programs and program parameters","description":"Retrieves a list of programs that can be started with Revenue APIs and the program parameters that you can specify."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_ProgramDetails","name":"List available programs and program parameters","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1programs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List available programs and program parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a list of programs that can be started with Revenue APIs and the program parameters that you can specify.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v1/programs","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/integration/v1/programs","href":"revenue-jobs/get_programdetails","openApiOperationId":"GET_ProgramDetails","summary":"List available programs and program parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of available programs is returned.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProgramDetailsResponse"}},"schemaId":"components/schemas/ProgramDetailsResponse"},{"code":"400","description":"The input parameter is invalid."}],"pointer":"/paths/~1api~1integration~1v1~1programs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProgramDetailsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProgramDetailsResponse"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-jobs/get_programdetails"}],"panels":[]}]},"httpPath":"/api/integration/v1/programs"},{"label":"List available organizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-jobs/get_revenueorgdetails","routeSlug":"/other-api/revenue-api-3.0/revenue-jobs/get_revenueorgdetails","metadata":{"seo":{"title":"List available organizations","description":"Retrieves the list of organizations that are set up in Zuora Revenue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RevenueOrgDetails","name":"List available organizations","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1revenue-orgs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List available organizations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the list of organizations that are set up in Zuora Revenue.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v1/revenue-orgs","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/integration/v1/revenue-orgs","href":"revenue-jobs/get_revenueorgdetails","openApiOperationId":"GET_RevenueOrgDetails","summary":"List available organizations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of available organizations is returned.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProgramDetailsResponse"}},"schemaId":"components/schemas/ProgramDetailsResponse"},{"code":"400","description":"The input parameter is invalid."}],"pointer":"/paths/~1api~1integration~1v1~1revenue-orgs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProgramDetailsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProgramDetailsResponse"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-jobs/get_revenueorgdetails"}],"panels":[]}]},"httpPath":"/api/integration/v1/revenue-orgs"},{"label":"Submit a program with specified parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-jobs/post_submitrevenuejob","routeSlug":"/other-api/revenue-api-3.0/revenue-jobs/post_submitrevenuejob","metadata":{"seo":{"title":"Submit a program with specified parameters","description":"Submits a program in Zuora Revenue and returns the job ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_SubmitRevenueJob","name":"Submit a program with specified parameters","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1{orgId}~1programs~1{programId}~1submit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a program with specified parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submits a program in Zuora Revenue and returns the job ID.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"programId","in":"path","schemaId":"schema_5","description":"The ID of the program that is to be submitted in Zuora Revenue. You can get the program ID by using the \"Get list of available programs and program parameters\" operation.","required":true},{"name":"orgId","in":"path","schemaId":"schema_5","description":"The ID of the organization for which the program is to be submitted. You can get the organization ID by using the \"Get list of available organizations\" operation.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1{orgId}~1programs~1{programId}~1submit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json; charset=utf-8"],"mediaTypeSchemas":{"application/json; charset=utf-8":{"schemaId":"components/schemas/SubmitJobRequest"}},"schemaId":"components/schemas/SubmitJobRequest","pointer":"/paths/~1api~1integration~1v1~1{orgId}~1programs~1{programId}~1submit/post/requestBody","description":"An array that contains the parameter values to be used for the program. For each parameter, you need to specify the parameter ID, sequence, and desired value. \nYou can get the parameter name, ID, and sequence by using the \"Get list of available programs and program parameters\" operation.\n"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/integration/v1/{orgId}/programs/{programId}/submit","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[{"name":"programId","in":"path","required":true,"schemaId":"schema_5"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json; charset=utf-8":{"schemaId":"components/schemas/SubmitJobRequest"}},"responseCodes":["200","400","403"],"pointer":"/api/integration/v1/{orgId}/programs/{programId}/submit","href":"revenue-jobs/post_submitrevenuejob","openApiOperationId":"POST_SubmitRevenueJob","summary":"Submit a program with specified parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"schemaId":"components/schemas/SubmitJobRequest","mediaTypes":["application/json; charset=utf-8"],"mediaTypeSchemas":{"application/json; charset=utf-8":{"schemaId":"components/schemas/SubmitJobRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The job status is returned with the job ID.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobStatusResponse"}},"schemaId":"components/schemas/JobStatusResponse"},{"code":"400","description":"The specified program is not supported.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmitJobFailureResponse"}},"schemaId":"components/schemas/SubmitJobFailureResponse"},{"code":"403","description":"The specified organization ID does not match the organization assigned to the current user role.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmitJobFailureResponse"}},"schemaId":"components/schemas/SubmitJobFailureResponse"}],"pointer":"/paths/~1api~1integration~1v1~1{orgId}~1programs~1{programId}~1submit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobStatusResponse"}}},{"code":"400","schemaId":"components/schemas/SubmitJobFailureResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmitJobFailureResponse"}}},{"code":"403","schemaId":"components/schemas/SubmitJobFailureResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubmitJobFailureResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-jobs/post_submitrevenuejob"}],"panels":[]}]},"httpPath":"/api/integration/v1/{orgId}/programs/{programId}/submit"},{"label":"Retrieve the job status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-jobs/get_revenuejobstatus","routeSlug":"/other-api/revenue-api-3.0/revenue-jobs/get_revenuejobstatus","metadata":{"seo":{"title":"Retrieve the job status","description":"Retrieves the status of a submitted job in Zuora Revenue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_RevenueJobStatus","name":"Retrieve the job status","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1{orgId}~1jobs~1{jobId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the job status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the status of a submitted job in Zuora Revenue.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobId","in":"path","schemaId":"schema_5","description":"The ID of the job.","required":true},{"name":"orgId","in":"path","schemaId":"schema_5","description":"The ID of the organization that is specified when the job is submitted.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1{orgId}~1jobs~1{jobId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v1/{orgId}/jobs/{jobId}","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[{"name":"jobId","in":"path","required":true,"schemaId":"schema_5"},{"name":"orgId","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/api/integration/v1/{orgId}/jobs/{jobId}","href":"revenue-jobs/get_revenuejobstatus","openApiOperationId":"GET_RevenueJobStatus","summary":"Retrieve the job status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The job status is returned.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobStatusResponse"}},"schemaId":"components/schemas/JobStatusResponse"},{"code":"400","description":"The input parameter is invalid."}],"pointer":"/paths/~1api~1integration~1v1~1{orgId}~1jobs~1{jobId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JobStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JobStatusResponse"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-jobs/get_revenuejobstatus"}],"panels":[]}]},"httpPath":"/api/integration/v1/{orgId}/jobs/{jobId}"}],"content":{"contentType":"group","meta":{"name":"Revenue Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revenue Jobs","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Revenue Jobs operations are used to submit the following programs with Revenue APIs:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RevPro3.0 Data Collection Master"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RevPro3.0 Event Process"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RevPro3.0 Event Process Master"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revpro3.0 Accounting Transfer Master"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RevPro3.0 Transfer Batch for Org"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No matter what program is to be started, two path parameters are required for the "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://developer.zuora.com/other-api/revenue/operation/POST_SubmitRevenueJob/"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit a program with specified parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation.  One is the program ID and the other is the organization ID. Operations are also provided to retrieve the program ID and organization ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For an example of using API to submit the Revpro3.0 Accounting Transfer Master program, see "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"https://docs.zuora.com?resourceId=revenue-api-best-practice-submit"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Us API to submit a predefined program"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the Knowledge Center."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/integration/v1/programs","summary":"List available programs and program parameters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-jobs/get_programdetails","deprecated":false},{"title":"/api/integration/v1/revenue-orgs","summary":"List available organizations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-jobs/get_revenueorgdetails","deprecated":false},{"title":"/api/integration/v1/{orgId}/programs/{programId}/submit","summary":"Submit a program with specified parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/revenue-jobs/post_submitrevenuejob","deprecated":false},{"title":"/api/integration/v1/{orgId}/jobs/{jobId}","summary":"Retrieve the job status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-jobs/get_revenuejobstatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Data Collection","link":"/other-api/revenue-api-3.0/data-collection","routeSlug":"/other-api/revenue-api-3.0/data-collection","items":[{"label":"Submit data collection job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/data-collection/post_collection","routeSlug":"/other-api/revenue-api-3.0/data-collection/post_collection","metadata":{"seo":{"title":"Submit data collection job","description":"Submit a data collection job based on the specified RC template."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST_Collection","name":"Submit data collection job","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1job~1collection~1template/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit data collection job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit a data collection job based on the specified RC template."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After the data collection job is submitted, the following validations are applied:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified RC template name must be valid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For multi-organization tenants, the the organization ID is required and must be valid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there are more than 2 data collection jobs in Running/Pending/Incompatible status for the specified organization, the API request will be rejected with error message returned."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json; charset=utf-8"],"mediaTypeSchemas":{"application/json; charset=utf-8":{"schemaId":"components/schemas/RevenueJobRequest"}},"schemaId":"components/schemas/RevenueJobRequest","pointer":"/paths/~1api~1integration~1v1~1job~1collection~1template/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/integration/v1/job/collection/template","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json; charset=utf-8":{"schemaId":"components/schemas/RevenueJobRequest"}},"responseCodes":["200","401","403"],"pointer":"/api/integration/v1/job/collection/template","href":"data-collection/post_collection","openApiOperationId":"POST_Collection","summary":"Submit data collection job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"schemaId":"components/schemas/RevenueJobRequest","mediaTypes":["application/json; charset=utf-8"],"mediaTypeSchemas":{"application/json; charset=utf-8":{"schemaId":"components/schemas/RevenueJobRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request is submitted successfully and the job ID is returned. You can use the returned ID to query the job status later.","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"components/schemas/RevenueJobResponse"}},"schemaId":"components/schemas/RevenueJobResponse"},{"code":"401","description":"The provided authentication token is invalid or the token has expired. Send the Authentication request again to get a new token."},{"code":"403","description":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support."}],"pointer":"/paths/~1api~1integration~1v1~1job~1collection~1template/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RevenueJobResponse","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"components/schemas/RevenueJobResponse"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-collection/post_collection"}],"panels":[]}]},"httpPath":"/api/integration/v1/job/collection/template"},{"label":"Retrieve data collection job details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/data-collection/get_collectiondetails","routeSlug":"/other-api/revenue-api-3.0/data-collection/get_collectiondetails","metadata":{"seo":{"title":"Retrieve data collection job details","description":"Get the status of the data collection job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET_CollectionDetails","name":"Retrieve data collection job details","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1job~1collection~1template~1{job_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve data collection job details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the status of the data collection job."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"job_id","in":"path","schemaId":"schema_5","description":"The ID of the data collection job that you want to query. This is the ID that is returned when you submitted the data collection job.","required":true}],"pointer":"/paths/~1api~1integration~1v1~1job~1collection~1template~1{job_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v1/job/collection/template/{job_id}","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"parameters":{"path":[{"name":"job_id","in":"path","required":true,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/api/integration/v1/job/collection/template/{job_id}","href":"data-collection/get_collectiondetails","openApiOperationId":"GET_CollectionDetails","summary":"Retrieve data collection job details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The request is submitted successfully.","mediaType":"application/json; charset=utf-8","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"components/schemas/RevenueJobDetail"}},"schemaId":"components/schemas/RevenueJobDetail"},{"code":"401","description":"The provided authentication token has expired. Send the Authentication request again to get a new token."},{"code":"403","description":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support."}],"pointer":"/paths/~1api~1integration~1v1~1job~1collection~1template~1{job_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RevenueJobDetail","mediaTypes":["application/json; charset=utf-8"],"mediaTypeContent":{"application/json; charset=utf-8":{"schemaId":"components/schemas/RevenueJobDetail"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/data-collection/get_collectiondetails"}],"panels":[]}]},"httpPath":"/api/integration/v1/job/collection/template/{job_id}"}],"content":{"contentType":"group","meta":{"name":"Data Collection"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Data Collection","showPageActions":true},{"nodeType":"markdoc","content":"The Data Collection operations are used to submit the data collection jobs and query the status of the submitted jobs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/integration/v1/job/collection/template","summary":"Submit data collection job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/data-collection/post_collection","deprecated":false},{"title":"/api/integration/v1/job/collection/template/{job_id}","summary":"Retrieve data collection job details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/data-collection/get_collectiondetails","deprecated":false}]}]}]}]}},{"type":"separator","label":"Revenue Reporting","content":null},{"type":"group","label":"Report Catalog","link":"/other-api/revenue-api-3.0/report-catalog","routeSlug":"/other-api/revenue-api-3.0/report-catalog","items":[{"label":"List reports","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-catalog/listreports","routeSlug":"/other-api/revenue-api-3.0/report-catalog/listreports","metadata":{"seo":{"title":"List reports","description":"Returns the report definitions in your tenant's report catalog, sorted by report name. Each item identifies a report and describes what it contains. This operation does not run a report and returns no report data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listReports","name":"List reports","isWebhook":false,"pointer":"/paths/~1revenue~1services~1v1~1reports/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List reports","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the report definitions in your tenant's report catalog, sorted by report name. Each item identifies a report and describes what it contains. This operation does not run a report and returns no report data."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use it as the first call of a reporting integration to find the numeric "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the report you want to run. Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"category"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to avoid paging through the whole catalog."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" At the start of any reporting integration, when you know a report's name or category but not its numeric ID, or when you want to show users the reports they can run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"category"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are exact matches that ignore letter case. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches either the stored report name or its translated display name."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pages are zero-based. The response is a plain JSON array; when it has fewer than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" items you have reached the last page."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-catalog/listreports/request/request-definition","deepLinkHash":"/report-catalog/listreports#report-catalog/listreports/request/request-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"query"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return only the report with this identifier."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"query"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return only the report with this exact name (case-insensitive)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"category"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"query"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return only reports in this category (case-insensitive)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"query"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zero-based page number."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"query"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"20"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of reports per page. Must be 1 or greater."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Language"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional language for translated report names, labels and filter options, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ja"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to the user's profile language."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zuora OneID OAuth)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-catalog/listreports/request/response-definition","deepLinkHash":"/report-catalog/listreports#report-catalog/listreports/request/response-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of Report"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ServiceError or SpringError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ServiceError"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A report definition in the tenant's report catalog. A report describes a data set (for example revenue waterfall or deferred revenue balances). It does not contain row data."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique numeric identifier of the report definition. Use it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in every other Reports call."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display name of the report. List reports returns the translated name when a translation exists for the caller's language; other operations return the stored name."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business description of what the report contains."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"category"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalog grouping the report belongs to, as configured in Zuora Revenue."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequence"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display order of the report inside its category. Lower numbers are shown first."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User name that created the report definition."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time the report definition was created, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User name that last changed the report definition."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time the report definition was last changed, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API overview and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response codes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each response with a body includes worked examples; responses without a body say so."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"id","in":"query","schemaId":"schema_22","description":"Return only the report with this identifier.","example":10021},{"name":"name","in":"query","schemaId":"schema_3","description":"Return only the report with this exact name (case-insensitive).","example":"Revenue Waterfall Report"},{"name":"category","in":"query","schemaId":"schema_3","description":"Return only reports in this category (case-insensitive).","example":"Revenue"},{"name":"page","in":"query","schemaId":"schema_23","description":"Zero-based page number.","example":0},{"name":"size","in":"query","schemaId":"schema_24","description":"Number of reports per page. Must be 1 or greater.","example":20}],"pointer":"/paths/~1revenue~1services~1v1~1reports/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Language","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional language for translated report names, labels and filter options, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ja"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to the user's profile language."},"children":[]}]}]}],"example":"en"},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1revenue~1services~1v1~1reports/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenue/services/v1/reports","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[],"query":[{"name":"id","in":"query","required":false,"example":10021,"schemaId":"schema_22"},{"name":"name","in":"query","required":false,"example":"Revenue Waterfall Report","schemaId":"schema_3"},{"name":"category","in":"query","required":false,"example":"Revenue","schemaId":"schema_3"},{"name":"page","in":"query","required":false,"example":0,"schemaId":"schema_23"},{"name":"size","in":"query","required":false,"example":20,"schemaId":"schema_24"}],"querystring":[],"header":[{"name":"Accept-Language","in":"header","required":false,"example":"en","schemaId":"schema_3"},{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/revenue/services/v1/reports","href":"report-catalog/listreports","openApiOperationId":"listReports","summary":"List reports"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The matching reports (possibly an empty array)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/200/content/application~1json/examples/byCategory","paths/~1revenue~1services~1v1~1reports/get/responses/200/content/application~1json/examples/empty"]}},"schemaId":"schema_25","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/200/content/application~1json/examples/byCategory","paths/~1revenue~1services~1v1~1reports/get/responses/200/content/application~1json/examples/empty"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" A query parameter is invalid, for example a negative "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of 0. Also returned when the tenant could not be resolved for Zuora Revenue."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/400/content/application~1json/examples/badPage","paths/~1revenue~1services~1v1~1reports/get/responses/400/content/application~1json/examples/tenant"]}},"schemaId":"schema_26","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/400/content/application~1json/examples/badPage","paths/~1revenue~1services~1v1~1reports/get/responses/400/content/application~1json/examples/tenant"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The access token is missing, invalid or expired. Request a new token and retry."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/401/content/application~1json/examples/unauthorized"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The OAuth client is authenticated but is not permitted to use Zuora Revenue APIs for this tenant."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unexpected server error. A non-numeric value for an integer parameter (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page=abc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is also reported with this status."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/500/content/application~1json/examples/typeMismatch"]}},"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/500/content/application~1json/examples/typeMismatch"]}],"pointer":"/paths/~1revenue~1services~1v1~1reports/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_25","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/200/content/application~1json/examples/byCategory","paths/~1revenue~1services~1v1~1reports/get/responses/200/content/application~1json/examples/empty"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/200/content/application~1json/examples/byCategory","paths/~1revenue~1services~1v1~1reports/get/responses/200/content/application~1json/examples/empty"]}}},{"code":"400","schemaId":"schema_26","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/400/content/application~1json/examples/badPage","paths/~1revenue~1services~1v1~1reports/get/responses/400/content/application~1json/examples/tenant"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/400/content/application~1json/examples/badPage","paths/~1revenue~1services~1v1~1reports/get/responses/400/content/application~1json/examples/tenant"]}}},{"code":"401","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/500/content/application~1json/examples/typeMismatch"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports/get/responses/500/content/application~1json/examples/typeMismatch"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-catalog/listreports"}],"panels":[]}]},"httpPath":"/revenue/services/v1/reports"},{"label":"Retrieve a report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-catalog/getreport","routeSlug":"/other-api/revenue-api-3.0/report-catalog/getreport","metadata":{"seo":{"title":"Retrieve a report","description":"Returns one report definition by its identifier."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReport","name":"Retrieve a report","isWebhook":false,"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns one report definition by its identifier."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Confirm that a report exists and read its name, category and audit details before you list its layouts or run it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When you already have a report ID (from configuration or a previous call) and want to confirm it still exists before you list layouts or run it."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-catalog/getreport/request/request-definition","deepLinkHash":"/report-catalog/getreport#report-catalog/getreport/request/request-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the report ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from List reports)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zuora OneID OAuth)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-catalog/getreport/request/response-definition","deepLinkHash":"/report-catalog/getreport#report-catalog/getreport/request/response-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpringError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No body"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ServiceError"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A report definition in the tenant's report catalog. A report describes a data set (for example revenue waterfall or deferred revenue balances). It does not contain row data."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique numeric identifier of the report definition. Use it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in every other Reports call."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display name of the report. List reports returns the translated name when a translation exists for the caller's language; other operations return the stored name."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business description of what the report contains."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"category"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Catalog grouping the report belongs to, as configured in Zuora Revenue."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sequence"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display order of the report inside its category. Lower numbers are shown first."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User name that created the report definition."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time the report definition was created, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User name that last changed the report definition."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time the report definition was last changed, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API overview and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response codes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each response with a body includes worked examples; responses without a body say so."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reportId","in":"path","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the report ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from List reports)."},"children":[]}]}]}],"required":true,"example":10021}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenue/services/v1/reports/{reportId}","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"reportId","in":"path","required":true,"example":10021,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenue/services/v1/reports/{reportId}","href":"report-catalog/getreport","openApiOperationId":"getReport","summary":"Retrieve a report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The report."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Report","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/200/content/application~1json/examples/found"]}},"schemaId":"components/schemas/Report","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/200/content/application~1json/examples/found"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The tenant could not be resolved for Zuora Revenue, or the database connection failed."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/400/content/application~1json/examples/tenant"]}},"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/400/content/application~1json/examples/tenant"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The access token is missing, invalid or expired. Request a new token and retry."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/401/content/application~1json/examples/unauthorized"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The OAuth client is authenticated but is not permitted to use Zuora Revenue APIs for this tenant."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" No report has this identifier. The response has no body."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unexpected server error. Retry later; if it persists, contact Zuora Support with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/500/content/application~1json/examples/serverError"]}},"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/500/content/application~1json/examples/serverError"]}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Report","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/200/content/application~1json/examples/found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Report","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/200/content/application~1json/examples/found"]}}},{"code":"400","schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/400/content/application~1json/examples/tenant"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/400/content/application~1json/examples/tenant"]}}},{"code":"401","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404"},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/500/content/application~1json/examples/serverError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/500/content/application~1json/examples/serverError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-catalog/getreport"}],"panels":[]}]},"httpPath":"/revenue/services/v1/reports/{reportId}"},{"label":"List layouts of a report","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-catalog/listreportlayouts","routeSlug":"/other-api/revenue-api-3.0/report-catalog/listreportlayouts","metadata":{"seo":{"title":"List layouts of a report","description":"Returns every layout of a report, sorted by layout name. Each layout includes its output columns (fields) and its filters with default values, required flags and allowed values."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listReportLayouts","name":"List layouts of a report","isWebhook":false,"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List layouts of a report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns every layout of a report, sorted by layout name. Each layout includes its output columns ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and its filters with default values, required flags and allowed values."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Choose the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you will run and learn which filters you must or may supply, without a separate call per layout."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Before your first run of a report, or whenever a layout may have changed, to choose a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and learn which filters are required and which values are allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the report does not exist or has no layouts, the response is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 0."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an exact, case-insensitive match on the layout name."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-catalog/listreportlayouts/request/request-definition","deepLinkHash":"/report-catalog/listreportlayouts#report-catalog/listreportlayouts/request/request-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the report."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"query"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return only the layout with this exact name (case-insensitive)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Language"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional language for translated report names, labels and filter options, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ja"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to the user's profile language."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zuora OneID OAuth)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-catalog/listreportlayouts/request/response-definition","deepLinkHash":"/report-catalog/listreportlayouts#report-catalog/listreportlayouts/request/response-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LayoutList"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpringError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ServiceError"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LayoutList"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Wrapper returned by the list-layouts operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of ReportLayout"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Layouts of the report, sorted by layout name. Each layout includes its fields and filters."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the layout. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you run the report."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].reportId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the report the layout belongs to."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Layout name."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Layout description."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filenamePrefix"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix used for the generated output file name."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].createdBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User name that created the layout."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].createdAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation date and time, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].updatedBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User name that last changed the layout."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].updatedAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last change date and time, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of LayoutField"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output columns of the layout, in output order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].fields[].id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of this column assignment within the layout."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].fields[].layoutId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the layout the column belongs to."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].fields[].fieldId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the underlying report field (column definition)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].fields[].seq"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Position of the column in the output file. Lower numbers appear further left."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].fields[].sortSeq"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort priority of the column. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the layout does not sort by this column."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].fields[].fieldName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical field name in lowerCamelCase. Use this value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you filter a report run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].fields[].fieldLabel"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Column heading shown in the output file, translated to the caller's language when a translation exists."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].fields[].fieldType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Database data type of the column, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VARCHAR2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NUMBER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_TIME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of LayoutFilter"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters defined on the layout, with required flags and allowed values."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the filter definition."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].layoutId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the layout the filter belongs to."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].fieldId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the report field the filter applies to."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].fieldName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical field name in lowerCamelCase. Send this as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a run request to override the filter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].fieldLabel"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display label of the filter, translated when a translation exists."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].fieldType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Database data type of the filtered field, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VARCHAR2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NUMBER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_TIME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the filter is presented and evaluated, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (pick from a list), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (from/to) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EQUALS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (single value)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].valueFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saved default value, or the lower bound of a range filter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].valueTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saved upper bound of a range filter. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for single-value filters."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].createdBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User name that created the filter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].createdAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation date and time, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].updatedBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User name that last changed the filter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].updatedAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last change date and time, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the layout requires a value for this filter before a run is accepted; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the filter is optional."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].options"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of FilterOption"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed values for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter. Always an array; empty for other filter types or when no list is configured."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].options[].label"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable text of the option, already translated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].filters[].options[].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value to send as the filter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you select this option."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"totalCount"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of layouts in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API overview and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response codes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each response with a body includes worked examples; responses without a body say so."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reportId","in":"path","schemaId":"schema_22","description":"Identifier of the report.","required":true,"example":10021}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_3","description":"Return only the layout with this exact name (case-insensitive).","example":"Monthly Close - Summary"}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Language","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional language for translated report names, labels and filter options, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ja"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to the user's profile language."},"children":[]}]}]}],"example":"en"},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenue/services/v1/reports/{reportId}/layouts","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"reportId","in":"path","required":true,"example":10021,"schemaId":"schema_22"}],"query":[{"name":"name","in":"query","required":false,"example":"Monthly Close - Summary","schemaId":"schema_3"}],"querystring":[],"header":[{"name":"Accept-Language","in":"header","required":false,"example":"en","schemaId":"schema_3"},{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/revenue/services/v1/reports/{reportId}/layouts","href":"report-catalog/listreportlayouts","openApiOperationId":"listReportLayouts","summary":"List layouts of a report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The layouts of the report."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LayoutList","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/200/content/application~1json/examples/layouts","paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/200/content/application~1json/examples/none"]}},"schemaId":"components/schemas/LayoutList","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/200/content/application~1json/examples/layouts","paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/200/content/application~1json/examples/none"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The tenant could not be resolved for Zuora Revenue, or the database connection failed."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/400/content/application~1json/examples/tenant"]}},"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/400/content/application~1json/examples/tenant"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The access token is missing, invalid or expired. Request a new token and retry."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/401/content/application~1json/examples/unauthorized"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The OAuth client is authenticated but is not permitted to use Zuora Revenue APIs for this tenant."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unexpected server error. Retry later; if it persists, contact Zuora Support with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/500/content/application~1json/examples/serverError"]}},"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/500/content/application~1json/examples/serverError"]}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LayoutList","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/200/content/application~1json/examples/layouts","paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/200/content/application~1json/examples/none"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LayoutList","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/200/content/application~1json/examples/layouts","paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/200/content/application~1json/examples/none"]}}},{"code":"400","schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/400/content/application~1json/examples/tenant"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/400/content/application~1json/examples/tenant"]}}},{"code":"401","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/500/content/application~1json/examples/serverError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/500/content/application~1json/examples/serverError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-catalog/listreportlayouts"}],"panels":[]}]},"httpPath":"/revenue/services/v1/reports/{reportId}/layouts"},{"label":"Retrieve a report layout","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-catalog/getreportlayout","routeSlug":"/other-api/revenue-api-3.0/report-catalog/getreportlayout","metadata":{"seo":{"title":"Retrieve a report layout","description":"Returns one layout of a report, including its output columns and filters."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReportLayout","name":"Retrieve a report layout","isWebhook":false,"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a report layout","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns one layout of a report, including its output columns and filters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Read the exact filters, defaults and allowed values of the layout you will run, so you can build a valid run request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When you run one known layout and need its current filters, defaults and allowed values to build or validate the run request."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The layout must belong to the report in the path; otherwise the response is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-catalog/getreportlayout/request/request-definition","deepLinkHash":"/report-catalog/getreportlayout#report-catalog/getreportlayout/request/request-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the report."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the layout."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Language"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional language for translated report names, labels and filter options, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ja"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to the user's profile language."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zuora OneID OAuth)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-catalog/getreportlayout/request/response-definition","deepLinkHash":"/report-catalog/getreportlayout#report-catalog/getreportlayout/request/response-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportLayout"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpringError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No body"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ServiceError"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportLayout"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A saved layout of a report: the columns to output, the filters with their defaults, and the output file-name prefix. A report can have many layouts."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the layout. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you run the report."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the report the layout belongs to."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Layout name."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Layout description."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filenamePrefix"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefix used for the generated output file name."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User name that created the layout."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation date and time, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User name that last changed the layout."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last change date and time, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of LayoutField"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output columns of the layout, in output order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields[].id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of this column assignment within the layout."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields[].layoutId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the layout the column belongs to."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields[].fieldId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the underlying report field (column definition)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields[].seq"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Position of the column in the output file. Lower numbers appear further left."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields[].sortSeq"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort priority of the column. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the layout does not sort by this column."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields[].fieldName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical field name in lowerCamelCase. Use this value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you filter a report run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields[].fieldLabel"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Column heading shown in the output file, translated to the caller's language when a translation exists."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields[].fieldType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Database data type of the column, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VARCHAR2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NUMBER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_TIME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of LayoutFilter"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters defined on the layout, with required flags and allowed values."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the filter definition."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].layoutId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the layout the filter belongs to."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].fieldId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the report field the filter applies to."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].fieldName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical field name in lowerCamelCase. Send this as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a run request to override the filter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].fieldLabel"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display label of the filter, translated when a translation exists."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].fieldType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Database data type of the filtered field, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VARCHAR2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NUMBER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_TIME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].type"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the filter is presented and evaluated, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (pick from a list), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (from/to) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EQUALS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (single value)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].valueFrom"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saved default value, or the lower bound of a range filter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].valueTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saved upper bound of a range filter. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for single-value filters."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].createdBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User name that created the filter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].createdAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation date and time, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].updatedBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User name that last changed the filter."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].updatedAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last change date and time, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].required"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the layout requires a value for this filter before a run is accepted; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the filter is optional."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].options"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of FilterOption"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed values for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter. Always an array; empty for other filter types or when no list is configured."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].options[].label"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable text of the option, already translated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].options[].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value to send as the filter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you select this option."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API overview and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response codes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each response with a body includes worked examples; responses without a body say so."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reportId","in":"path","schemaId":"schema_22","description":"Identifier of the report.","required":true,"example":10021},{"name":"layoutId","in":"path","schemaId":"schema_22","description":"Identifier of the layout.","required":true,"example":3105}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Language","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional language for translated report names, labels and filter options, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ja"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to the user's profile language."},"children":[]}]}]}],"example":"en"},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenue/services/v1/reports/{reportId}/layouts/{layoutId}","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"reportId","in":"path","required":true,"example":10021,"schemaId":"schema_22"},{"name":"layoutId","in":"path","required":true,"example":3105,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[{"name":"Accept-Language","in":"header","required":false,"example":"en","schemaId":"schema_3"},{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenue/services/v1/reports/{reportId}/layouts/{layoutId}","href":"report-catalog/getreportlayout","openApiOperationId":"getReportLayout","summary":"Retrieve a report layout"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The layout."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportLayout","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/200/content/application~1json/examples/found"]}},"schemaId":"components/schemas/ReportLayout","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/200/content/application~1json/examples/found"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The tenant could not be resolved for Zuora Revenue, or the database connection failed."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/400/content/application~1json/examples/tenant"]}},"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/400/content/application~1json/examples/tenant"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The access token is missing, invalid or expired. Request a new token and retry."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/401/content/application~1json/examples/unauthorized"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The OAuth client is authenticated but is not permitted to use Zuora Revenue APIs for this tenant."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The layout does not exist or does not belong to the report. The response has no body."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unexpected server error. Retry later; if it persists, contact Zuora Support with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/500/content/application~1json/examples/serverError"]}},"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/500/content/application~1json/examples/serverError"]}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportLayout","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/200/content/application~1json/examples/found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportLayout","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/200/content/application~1json/examples/found"]}}},{"code":"400","schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/400/content/application~1json/examples/tenant"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/400/content/application~1json/examples/tenant"]}}},{"code":"401","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404"},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/500/content/application~1json/examples/serverError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/500/content/application~1json/examples/serverError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-catalog/getreportlayout"}],"panels":[]}]},"httpPath":"/revenue/services/v1/reports/{reportId}/layouts/{layoutId}"},{"label":"List the columns of a layout","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-catalog/listreportlayoutfields","routeSlug":"/other-api/revenue-api-3.0/report-catalog/listreportlayoutfields","metadata":{"seo":{"title":"List the columns of a layout","description":"Returns only the output columns of a layout, in output order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listReportLayoutFields","name":"List the columns of a layout","isWebhook":false,"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the columns of a layout","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns only the output columns of a layout, in output order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Map the columns of the output file to your target system (for example a data warehouse table) before you download it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When you load the output file into another system and need the column order, names and data types to map the file to a target table."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The layout must belong to the report in the path; otherwise the response is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation returns the column labels and data types stored on the layout columns. They are not translated and can differ from the values returned inside List layouts and Get a layout."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-catalog/listreportlayoutfields/request/request-definition","deepLinkHash":"/report-catalog/listreportlayoutfields#report-catalog/listreportlayoutfields/request/request-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the report."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the layout."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zuora OneID OAuth)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-catalog/listreportlayoutfields/request/response-definition","deepLinkHash":"/report-catalog/listreportlayoutfields#report-catalog/listreportlayoutfields/request/response-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LayoutFieldList"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpringError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No body"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ServiceError"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LayoutFieldList"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Wrapper returned by the list-layout-fields operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutFields"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of LayoutField"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output columns of the layout."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutFields[].id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of this column assignment within the layout."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutFields[].layoutId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the layout the column belongs to."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutFields[].fieldId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the underlying report field (column definition)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutFields[].seq"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Position of the column in the output file. Lower numbers appear further left."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutFields[].sortSeq"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort priority of the column. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the layout does not sort by this column."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutFields[].fieldName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical field name in lowerCamelCase. Use this value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you filter a report run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutFields[].fieldLabel"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Column heading shown in the output file, translated to the caller's language when a translation exists."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutFields[].fieldType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Database data type of the column, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VARCHAR2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NUMBER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_TIME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API overview and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response codes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each response with a body includes worked examples; responses without a body say so."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reportId","in":"path","schemaId":"schema_22","description":"Identifier of the report.","required":true,"example":10021},{"name":"layoutId","in":"path","schemaId":"schema_22","description":"Identifier of the layout.","required":true,"example":3105}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenue/services/v1/reports/{reportId}/layouts/{layoutId}/fields","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"reportId","in":"path","required":true,"example":10021,"schemaId":"schema_22"},{"name":"layoutId","in":"path","required":true,"example":3105,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenue/services/v1/reports/{reportId}/layouts/{layoutId}/fields","href":"report-catalog/listreportlayoutfields","openApiOperationId":"listReportLayoutFields","summary":"List the columns of a layout"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The columns of the layout."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LayoutFieldList","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/200/content/application~1json/examples/fields"]}},"schemaId":"components/schemas/LayoutFieldList","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/200/content/application~1json/examples/fields"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The tenant could not be resolved for Zuora Revenue, or the database connection failed."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/400/content/application~1json/examples/tenant"]}},"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/400/content/application~1json/examples/tenant"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The access token is missing, invalid or expired. Request a new token and retry."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/401/content/application~1json/examples/unauthorized"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The OAuth client is authenticated but is not permitted to use Zuora Revenue APIs for this tenant."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The layout does not exist or does not belong to the report. The response has no body."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unexpected server error. Retry later; if it persists, contact Zuora Support with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/500/content/application~1json/examples/serverError"]}},"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/500/content/application~1json/examples/serverError"]}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LayoutFieldList","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/200/content/application~1json/examples/fields"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LayoutFieldList","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/200/content/application~1json/examples/fields"]}}},{"code":"400","schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/400/content/application~1json/examples/tenant"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/400/content/application~1json/examples/tenant"]}}},{"code":"401","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404"},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/500/content/application~1json/examples/serverError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/500/content/application~1json/examples/serverError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-catalog/listreportlayoutfields"}],"panels":[]}]},"httpPath":"/revenue/services/v1/reports/{reportId}/layouts/{layoutId}/fields"},{"label":"Retrieve report metadata by ID or name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-catalog/getreportmetadata","routeSlug":"/other-api/revenue-api-3.0/report-catalog/getreportmetadata","metadata":{"seo":{"title":"Retrieve report metadata by ID or name","description":"Returns a report's identity, whether it is a standard or custom report, every field it can output, and its layouts with the default layout flagged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReportMetadata","name":"Retrieve report metadata by ID or name","isWebhook":false,"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve report metadata by ID or name","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a report's identity, whether it is a standard or custom report, every field it can output, and its layouts with the default layout flagged."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resolve a report from a name you already know (for example from configuration) and find its default layout in a single call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When your configuration stores report names rather than IDs, or when you need the default layout of a report in a single call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportIdentifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is treated as a report ID when it is numeric; otherwise it is matched to the report name exactly, ignoring case and surrounding spaces. A report whose name is only digits can therefore be found only by its ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.parameters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are reserved and currently empty. Use the layout operations to read filters."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-catalog/getreportmetadata/request/request-definition","deepLinkHash":"/report-catalog/getreportmetadata#report-catalog/getreportmetadata/request/request-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportIdentifier"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report ID (numeric) or exact report name. URL-encode spaces as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zuora OneID OAuth)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-catalog/getreportmetadata/request/response-definition","deepLinkHash":"/report-catalog/getreportmetadata#report-catalog/getreportmetadata/request/response-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportMetadata"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpringError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No body"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ServiceError"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportMetadata"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Report metadata: identity, type, available columns and layouts."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the report."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the report."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a report delivered by Zuora; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a report your organization created. Allowed: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportMetadataInfo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description, columns and reserved arrays."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.description"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Business description of the report."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reserved for future use. Currently always an empty array."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of object"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reserved for future use. Currently always an empty array. Read filters from the layout operations instead."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.columns"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of ReportMetadataColumn"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All fields the report can output."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.columns[].id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the report field."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.columns[].fieldName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical field name as stored in the report definition (UPPER_SNAKE_CASE)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.columns[].alias"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Column alias used in the report output."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.columns[].fieldType"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data type of the field."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.columns[].label"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display label of the field."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of ReportMetadataLayout"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Layouts available for the report."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].layoutId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the layout."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].layoutName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the layout."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts[].isDefault"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when this is the report's default layout."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API overview and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response codes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each response with a body includes worked examples; responses without a body say so."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reportIdentifier","in":"path","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report ID (numeric) or exact report name. URL-encode spaces as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"Revenue Waterfall Report"}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenue/services/v1/reports/{reportIdentifier}/metadata","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"reportIdentifier","in":"path","required":true,"example":"Revenue Waterfall Report","schemaId":"schema_3"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenue/services/v1/reports/{reportIdentifier}/metadata","href":"report-catalog/getreportmetadata","openApiOperationId":"getReportMetadata","summary":"Retrieve report metadata by ID or name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The report metadata."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportMetadata","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/200/content/application~1json/examples/byName"]}},"schemaId":"components/schemas/ReportMetadata","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/200/content/application~1json/examples/byName"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The identifier is blank (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%20"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). That case has no response body. The tenant could not be resolved for Zuora Revenue, or the database connection failed."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/400/content/application~1json/examples/tenant"]}},"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/400/content/application~1json/examples/tenant"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The access token is missing, invalid or expired. Request a new token and retry."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/401/content/application~1json/examples/unauthorized"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The OAuth client is authenticated but is not permitted to use Zuora Revenue APIs for this tenant."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" No report matches the ID or name. The response has no body."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unexpected server error. Retry later; if it persists, contact Zuora Support with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/500/content/application~1json/examples/serverError"]}},"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/500/content/application~1json/examples/serverError"]}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportMetadata","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/200/content/application~1json/examples/byName"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportMetadata","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/200/content/application~1json/examples/byName"]}}},{"code":"400","schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/400/content/application~1json/examples/tenant"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/400/content/application~1json/examples/tenant"]}}},{"code":"401","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404"},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/500/content/application~1json/examples/serverError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/500/content/application~1json/examples/serverError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-catalog/getreportmetadata"}],"panels":[]}]},"httpPath":"/revenue/services/v1/reports/{reportIdentifier}/metadata"}],"content":{"contentType":"group","meta":{"name":"Report Catalog"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Catalog","showPageActions":true},{"nodeType":"markdoc","content":"Discover the reports in your tenant, their layouts, output columns, filters and metadata."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue/services/v1/reports","summary":"List reports","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-catalog/listreports","deprecated":false},{"title":"/revenue/services/v1/reports/{reportId}","summary":"Retrieve a report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-catalog/getreport","deprecated":false},{"title":"/revenue/services/v1/reports/{reportId}/layouts","summary":"List layouts of a report","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-catalog/listreportlayouts","deprecated":false},{"title":"/revenue/services/v1/reports/{reportId}/layouts/{layoutId}","summary":"Retrieve a report layout","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-catalog/getreportlayout","deprecated":false},{"title":"/revenue/services/v1/reports/{reportId}/layouts/{layoutId}/fields","summary":"List the columns of a layout","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-catalog/listreportlayoutfields","deprecated":false},{"title":"/revenue/services/v1/reports/{reportIdentifier}/metadata","summary":"Retrieve report metadata by ID or name","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-catalog/getreportmetadata","deprecated":false}]}]}]}]}},{"type":"group","label":"Report Runs","link":"/other-api/revenue-api-3.0/report-runs","routeSlug":"/other-api/revenue-api-3.0/report-runs","items":[{"label":"Run a report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-runs/runreport","routeSlug":"/other-api/revenue-api-3.0/report-runs/runreport","metadata":{"seo":{"title":"Run a report","description":"Submits a report layout for background execution and returns the new run. A 200 response means the run was accepted, not that the file is ready. Poll Get a report run until status is Available, then call Get a download URL."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"runReport","name":"Run a report","isWebhook":false,"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run a report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submits a report layout for background execution and returns the new run. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response means the run was accepted, not that the file is ready. Poll "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a report run"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then call "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a download URL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Produce report files on demand from your own scheduler, for example at period close or for an auditor extract, without using the Zuora Revenue user interface."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Each time you need a fresh report file: period close, an auditor request, a scheduled data feed, or an on-demand extract triggered by another system."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters are merged with the layout's saved defaults: omit "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use all defaults; send some filters to override only those (your values win, defaults fill the rest); send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use no filters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required layout filters are checked after the merge. If any is still missing, the run is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the labels of the missing filters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$revpro.CurrPrd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$revpro.PriorPrd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are replaced with the current or prior open period of the book and organization. If that cannot be resolved (for example several organizations with different open periods), the run is rejected with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_PERIOD_ORG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; send a concrete period name or organization instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date values use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-999"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for book, period and organization filters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned by List layouts for the same report. Operators outside the documented list are not supported and can make the run fail."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-runs/runreport/request/request-definition","deepLinkHash":"/report-runs/runreport#report-runs/runreport/request/request-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the report to run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Accept-Language"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional language for translated report names, labels and filter options, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ja"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to the user's profile language."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zuora OneID OAuth)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): RunReportRequest"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RunReportRequest"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Request body that submits a report layout for execution."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the layout to run. Use a layout returned by List layouts for the same report."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of ReportFilterParam"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter conditions. Omit the property (or send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to apply all saved layout defaults. Send a partial list to override some filters; layout defaults fill in the rest. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to run with no filters at all (required filters are still enforced)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].fieldName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to filter on, in lowerCamelCase as returned by the layout operations (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The service converts it to the stored field key."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].operator"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison operator. When omitted, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used. See "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter operators"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the value rules of each operator. Allowed: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"!="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":">="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIKE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT LIKE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IS NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IS NOT NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BETWEEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].value"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter value. Dates use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a comma-separated list. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the from-book. Omit for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IS NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IS NOT NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The macros "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$revpro.CurrPrd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$revpro.PriorPrd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are replaced with the current or prior open period name."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[].valueTo"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upper bound for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BETWEEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (date "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or the to-book for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Not used by other operators."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-runs/runreport/request/response-definition","deepLinkHash":"/report-runs/runreport#report-runs/runreport/request/response-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportRun"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MissingFiltersError or SimpleError or ServiceError or SpringError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SimpleError or ServiceError"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportRun"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": One execution (submission) of a report layout."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission identifier of the run. Use it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submissionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to poll status and download."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the report that was run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the layout that was run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current run status. See "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report run status values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Allowed: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Submitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Upload Started"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File Created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Terminated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the output file. Populated once the file is produced."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON text of the filters stored for the run, after defaults and period macros were resolved. Filters are stored with internal filter keys ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), operator ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", omitted for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and values ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"val1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"val2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Treat the content as informational; its format can change."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON text of output options: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Show Filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Y/N, print the filters in the file) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Enable Totals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Y/N, add total rows)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User that submitted the run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time the run was submitted, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User or process that last updated the run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time of the last status change, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API overview and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response codes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each response with a body includes worked examples; responses without a body say so."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reportId","in":"path","schemaId":"schema_22","description":"Identifier of the report to run.","required":true,"example":10021}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Accept-Language","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional language for translated report names, labels and filter options, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ja"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to the user's profile language."},"children":[]}]}]}],"example":"en"},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RunReportRequest","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/defaults","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/override","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/dateRange","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/macro"]}},"schemaId":"components/schemas/RunReportRequest","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/defaults","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/override","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/dateRange","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/macro"],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody","description":"The layout to run and optional filter overrides."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue/services/v1/reports/{reportId}/run","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"reportId","in":"path","required":true,"example":10021,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[{"name":"Accept-Language","in":"header","required":false,"example":"en","schemaId":"schema_3"},{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RunReportRequest","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/defaults","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/override","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/dateRange","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/macro"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/revenue/services/v1/reports/{reportId}/run","href":"report-runs/runreport","openApiOperationId":"runReport","summary":"Run a report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"schemaId":"components/schemas/RunReportRequest","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/defaults","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/override","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/dateRange","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/macro"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RunReportRequest","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/defaults","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/override","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/dateRange","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/macro"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The run was accepted. Save "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; it is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submissionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for status and download."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportRun","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/200/content/application~1json/examples/accepted"]}},"schemaId":"components/schemas/ReportRun","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/200/content/application~1json/examples/accepted"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The request was rejected: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" missing, a required filter has no value, a period macro could not be resolved, or the body could not be processed. Also returned when the tenant could not be resolved for Zuora Revenue."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/missingLayout","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/missingFilters","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodMultiple","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodNone","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodBook","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/invalidRequest","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/tenant"]}},"schemaId":"schema_28","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/missingLayout","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/missingFilters","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodMultiple","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodNone","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodBook","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/invalidRequest","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/tenant"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The access token is missing, invalid or expired. Request a new token and retry."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/401/content/application~1json/examples/unauthorized"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The OAuth client is authenticated but is not permitted to use Zuora Revenue APIs for this tenant."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/403/content/application~1json/examples/forbidden"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unexpected error while submitting the run (for example an unknown "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or a malformed JSON body). Check the request; if it is correct, retry later."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/500/content/application~1json/examples/internal","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/500/content/application~1json/examples/malformedJson"]}},"schemaId":"schema_29","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/500/content/application~1json/examples/internal","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/500/content/application~1json/examples/malformedJson"]}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportRun","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/200/content/application~1json/examples/accepted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportRun","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/200/content/application~1json/examples/accepted"]}}},{"code":"400","schemaId":"schema_28","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/missingLayout","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/missingFilters","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodMultiple","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodNone","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodBook","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/invalidRequest","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/tenant"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/missingLayout","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/missingFilters","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodMultiple","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodNone","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodBook","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/invalidRequest","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/tenant"]}}},{"code":"401","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"schema_29","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/500/content/application~1json/examples/internal","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/500/content/application~1json/examples/malformedJson"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29","exampleIds":["paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/500/content/application~1json/examples/internal","paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/500/content/application~1json/examples/malformedJson"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-runs/runreport"}],"panels":[]}]},"httpPath":"/revenue/services/v1/reports/{reportId}/run"},{"label":"Retrieve a report run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-runs/getreportrun","routeSlug":"/other-api/revenue-api-3.0/report-runs/getreportrun","metadata":{"seo":{"title":"Retrieve a report run","description":"Returns the current state of one report run."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReportRun","name":"Retrieve a report run","isWebhook":false,"pointer":"/paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a report run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the current state of one report run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Poll a run you submitted until it reaches a final status. Poll every 10 to 30 seconds and stop when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Terminated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" After Run a report, to poll until the run reaches a final status, or later to check the outcome of a known run."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-runs/getreportrun/request/request-definition","deepLinkHash":"/report-runs/getreportrun#report-runs/getreportrun/request/request-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submissionId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Run identifier ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned by Run a report)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zuora OneID OAuth)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-runs/getreportrun/request/response-definition","deepLinkHash":"/report-runs/getreportrun#report-runs/getreportrun/request/response-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportRun"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpringError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No body"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ServiceError"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportRun"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": One execution (submission) of a report layout."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission identifier of the run. Use it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submissionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to poll status and download."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the report that was run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the layout that was run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current run status. See "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report run status values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Allowed: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Submitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Upload Started"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File Created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Terminated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the output file. Populated once the file is produced."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON text of the filters stored for the run, after defaults and period macros were resolved. Filters are stored with internal filter keys ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), operator ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", omitted for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and values ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"val1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"val2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Treat the content as informational; its format can change."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON text of output options: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Show Filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Y/N, print the filters in the file) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Enable Totals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Y/N, add total rows)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User that submitted the run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time the run was submitted, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User or process that last updated the run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time of the last status change, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API overview and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response codes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each response with a body includes worked examples; responses without a body say so."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"submissionId","in":"path","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Run identifier ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned by Run a report)."},"children":[]}]}]}],"required":true,"example":482391}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenue/services/v1/reports/run/{submissionId}","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"submissionId","in":"path","required":true,"example":482391,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenue/services/v1/reports/run/{submissionId}","href":"report-runs/getreportrun","openApiOperationId":"getReportRun","summary":"Retrieve a report run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The run."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportRun","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/inProgress","paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/available","paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/failed"]}},"schemaId":"components/schemas/ReportRun","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/inProgress","paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/available","paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/failed"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The tenant could not be resolved for Zuora Revenue, or the database connection failed."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/400/content/application~1json/examples/tenant"]}},"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/400/content/application~1json/examples/tenant"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The access token is missing, invalid or expired. Request a new token and retry."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/401/content/application~1json/examples/unauthorized"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The OAuth client is authenticated but is not permitted to use Zuora Revenue APIs for this tenant."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" No run has this identifier. The response has no body."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unexpected server error. Retry later; if it persists, contact Zuora Support with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/500/content/application~1json/examples/serverError"]}},"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/500/content/application~1json/examples/serverError"]}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportRun","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/inProgress","paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/available","paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportRun","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/inProgress","paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/available","paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/failed"]}}},{"code":"400","schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/400/content/application~1json/examples/tenant"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/400/content/application~1json/examples/tenant"]}}},{"code":"401","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404"},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/500/content/application~1json/examples/serverError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/500/content/application~1json/examples/serverError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-runs/getreportrun"}],"panels":[]}]},"httpPath":"/revenue/services/v1/reports/run/{submissionId}"},{"label":"Retrieve the latest finished report run","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-runs/getlatestreportrun","routeSlug":"/other-api/revenue-api-3.0/report-runs/getlatestreportrun","metadata":{"seo":{"title":"Retrieve the latest finished report run","description":"Returns the most recent report run in the tenant, across all reports, that has reached a final status (Available, Error, Terminated or Cancelled)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLatestReportRun","name":"Retrieve the latest finished report run","isWebhook":false,"pointer":"/paths/~1revenue~1services~1v1~1reports~1run~1latest/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the latest finished report run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the most recent report run in the tenant, across all reports, that has reached a final status ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Terminated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Check the outcome of the last report produced in the tenant, for example in a monitoring job, without knowing its submission ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In monitoring or health-check jobs that need the outcome of the most recent finished run without tracking submission IDs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Runs that are still in progress are ignored."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-runs/getlatestreportrun/request/request-definition","deepLinkHash":"/report-runs/getlatestreportrun#report-runs/getlatestreportrun/request/request-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zuora OneID OAuth)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-runs/getlatestreportrun/request/response-definition","deepLinkHash":"/report-runs/getlatestreportrun#report-runs/getlatestreportrun/request/response-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportRun"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SpringError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No body"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ServiceError"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportRun"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": One execution (submission) of a report layout."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission identifier of the run. Use it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submissionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to poll status and download."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the report that was run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the layout that was run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current run status. See "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report run status values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Allowed: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Submitted"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Upload Started"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File Created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Terminated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fileName"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the output file. Populated once the file is produced."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filterParameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON text of the filters stored for the run, after defaults and period macros were resolved. Filters are stored with internal filter keys ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), operator ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", omitted for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and values ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"val1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"val2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Treat the content as informational; its format can change."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON text of output options: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Show Filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Y/N, print the filters in the file) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Enable Totals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Y/N, add total rows)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User that submitted the run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"runDate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time the run was submitted, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedBy"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User or process that last updated the run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time of the last status change, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API overview and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response codes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each response with a body includes worked examples; responses without a body say so."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1run~1latest/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenue/services/v1/reports/run/latest","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenue/services/v1/reports/run/latest","href":"report-runs/getlatestreportrun","openApiOperationId":"getLatestReportRun","summary":"Retrieve the latest finished report run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The latest finished run."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportRun","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/200/content/application~1json/examples/latest"]}},"schemaId":"components/schemas/ReportRun","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/200/content/application~1json/examples/latest"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The tenant could not be resolved for Zuora Revenue, or the database connection failed."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/400/content/application~1json/examples/tenant"]}},"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/400/content/application~1json/examples/tenant"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The access token is missing, invalid or expired. Request a new token and retry."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/401/content/application~1json/examples/unauthorized"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The OAuth client is authenticated but is not permitted to use Zuora Revenue APIs for this tenant."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" No finished run exists in the tenant. The response has no body."},"children":[]}]}]}]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unexpected server error. Retry later; if it persists, contact Zuora Support with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/500/content/application~1json/examples/serverError"]}},"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/500/content/application~1json/examples/serverError"]}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportRun","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/200/content/application~1json/examples/latest"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportRun","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/200/content/application~1json/examples/latest"]}}},{"code":"400","schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/400/content/application~1json/examples/tenant"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpringError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/400/content/application~1json/examples/tenant"]}}},{"code":"401","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404"},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/500/content/application~1json/examples/serverError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/500/content/application~1json/examples/serverError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-runs/getlatestreportrun"}],"panels":[]}]},"httpPath":"/revenue/services/v1/reports/run/latest"},{"label":"Retrieve a download URL","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-runs/getreportrundownloadurl","routeSlug":"/other-api/revenue-api-3.0/report-runs/getreportrundownloadurl","metadata":{"seo":{"title":"Retrieve a download URL","description":"Returns a pre-signed HTTPS URL for the output file of an Available run. The URL is valid for 30 minutes. Download the file with a plain HTTP GET on that URL, without an Authorization header."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReportRunDownloadUrl","name":"Retrieve a download URL","isWebhook":false,"pointer":"/paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a download URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a pre-signed HTTPS URL for the output file of an Available run. The URL is valid for 30 minutes. Download the file with a plain HTTP GET on that URL, without an Authorization header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retrieve large report files securely and directly from file storage, without streaming them through the API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" As soon as a run is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to download its file. Call it again if a previous URL has expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request the URL only when the run status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; otherwise the response is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the current status code."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the URL expires, call this operation again to get a new one."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-runs/getreportrundownloadurl/request/request-definition","deepLinkHash":"/report-runs/getreportrundownloadurl#report-runs/getreportrundownloadurl/request/request-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submissionId"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Run identifier."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zuora OneID OAuth)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-runs/getreportrundownloadurl/request/response-definition","deepLinkHash":"/report-runs/getreportrundownloadurl#report-runs/getreportrundownloadurl/request/response-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportDownload"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SimpleError or SpringError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No body"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RunStatusConflict"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ServiceError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"503"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SimpleError"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportDownload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Time-limited download link for a completed report file."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"presignedUrl"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (uri)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTPS URL of the report file. Download it with a plain HTTP GET and no Authorization header. Valid for 30 minutes."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiresAt"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (date-time)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTC date and time after which the URL stops working, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API overview and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response codes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"503"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each response with a body includes worked examples; responses without a body say so."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"submissionId","in":"path","schemaId":"schema_30","description":"Run identifier.","required":true,"example":482391}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenue/services/v1/reports/run/{submissionId}/download","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"submissionId","in":"path","required":true,"example":482391,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500","503"],"pointer":"/revenue/services/v1/reports/run/{submissionId}/download","href":"report-runs/getreportrundownloadurl","openApiOperationId":"getReportRunDownloadUrl","summary":"Retrieve a download URL"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The download URL."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportDownload","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/200/content/application~1json/examples/url"]}},"schemaId":"components/schemas/ReportDownload","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/200/content/application~1json/examples/url"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The run's file reference is invalid, so no URL can be generated. Also returned when the tenant could not be resolved for Zuora Revenue."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/400/content/application~1json/examples/badRef","paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/400/content/application~1json/examples/tenant"]}},"schemaId":"schema_31","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/400/content/application~1json/examples/badRef","paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/400/content/application~1json/examples/tenant"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The access token is missing, invalid or expired. Request a new token and retry."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/401/content/application~1json/examples/unauthorized"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/401/content/application~1json/examples/unauthorized"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The OAuth client is authenticated but is not permitted to use Zuora Revenue APIs for this tenant."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/403/content/application~1json/examples/forbidden"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/403/content/application~1json/examples/forbidden"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" No run has this identifier. The response has no body."},"children":[]}]}]}]},{"code":"409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The run is not Available yet (or failed). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds the one-letter status code."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RunStatusConflict","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/409/content/application~1json/examples/notReady","paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/409/content/application~1json/examples/failed"]}},"schemaId":"components/schemas/RunStatusConflict","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/409/content/application~1json/examples/notReady","paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/409/content/application~1json/examples/failed"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unexpected server error. Retry later; if it persists, contact Zuora Support with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/500/content/application~1json/examples/serverError"]}},"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/500/content/application~1json/examples/serverError"]},{"code":"503","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The URL could not be signed because file storage was temporarily unavailable. Retry."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/503/content/application~1json/examples/presign"]}},"schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/503/content/application~1json/examples/presign"]}],"pointer":"/paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportDownload","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/200/content/application~1json/examples/url"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportDownload","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/200/content/application~1json/examples/url"]}}},{"code":"400","schemaId":"schema_31","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/400/content/application~1json/examples/badRef","paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/400/content/application~1json/examples/tenant"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/400/content/application~1json/examples/badRef","paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/400/content/application~1json/examples/tenant"]}}},{"code":"401","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/401/content/application~1json/examples/unauthorized"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/401/content/application~1json/examples/unauthorized"]}}},{"code":"403","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/403/content/application~1json/examples/forbidden"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/403/content/application~1json/examples/forbidden"]}}},{"code":"404"},{"code":"409","schemaId":"components/schemas/RunStatusConflict","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/409/content/application~1json/examples/notReady","paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/409/content/application~1json/examples/failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RunStatusConflict","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/409/content/application~1json/examples/notReady","paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/409/content/application~1json/examples/failed"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/500/content/application~1json/examples/serverError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/500/content/application~1json/examples/serverError"]}}},{"code":"503","schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/503/content/application~1json/examples/presign"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SimpleError","exampleIds":["paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/503/content/application~1json/examples/presign"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-runs/getreportrundownloadurl"}],"panels":[]}]},"httpPath":"/revenue/services/v1/reports/run/{submissionId}/download"}],"content":{"contentType":"group","meta":{"name":"Report Runs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Runs","showPageActions":true},{"nodeType":"markdoc","content":"Submit a report layout for execution, poll the run, and download the result file."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue/services/v1/reports/{reportId}/run","summary":"Run a report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/report-runs/runreport","deprecated":false},{"title":"/revenue/services/v1/reports/run/{submissionId}","summary":"Retrieve a report run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-runs/getreportrun","deprecated":false},{"title":"/revenue/services/v1/reports/run/latest","summary":"Retrieve the latest finished report run","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-runs/getlatestreportrun","deprecated":false},{"title":"/revenue/services/v1/reports/run/{submissionId}/download","summary":"Retrieve a download URL","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-runs/getreportrundownloadurl","deprecated":false}]}]}]}]}},{"type":"group","label":"Report Files","link":"/other-api/revenue-api-3.0/report-files","routeSlug":"/other-api/revenue-api-3.0/report-files","items":[{"label":"List report files by date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-files/listreportfilesbydate","routeSlug":"/other-api/revenue-api-3.0/report-files/listreportfilesbydate","metadata":{"seo":{"title":"List report files by date","description":"Returns the Available report files created on one calendar day, limited to the organizations your role can access. Runs that are still in progress or failed are not returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listReportFilesByDate","name":"List report files by date","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1reports~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List report files by date","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the Available report files created on one calendar day, limited to the organizations your role can access. Runs that are still in progress or failed are not returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Collect every report produced on a given day (for example by schedules in Zuora Revenue) so a nightly job can download them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" In a daily job that collects every report file produced on a given day, for example by report schedules set up in Zuora Revenue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createddate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uses the format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD-Mon-YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an English month abbreviation, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"09-Oct-2026"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The month is not case-sensitive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When nothing matches, the response is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-files/listreportfilesbydate/request/request-definition","deepLinkHash":"/report-files/listreportfilesbydate#report-files/listreportfilesbydate/request/request-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createddate"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"query"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation date of the report files, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD-Mon-YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zuora OneID OAuth)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-files/listreportfilesbydate/request/response-definition","deepLinkHash":"/report-files/listreportfilesbydate#report-files/listreportfilesbydate/request/response-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportFileListResponse"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError or RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportFileListResponse"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Success envelope for the report-file operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the call completed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Message"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional message. Empty on success."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of ReportFile"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Matching Available report files. An empty array means nothing matched."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission identifier of the run that produced the file. Use it with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /reports/{report_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the v2 signed-URL operation."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].file_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the generated file. Use it with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /reports/download/{filename}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].rep_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the report definition that produced the file."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].category"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report category."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].rep_desc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report description."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].layout_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the layout that was run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].report_date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time the run was created, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD-MM-YYYY HH24:MI:SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Run status. These operations only return Available runs, so the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on some tenant database platforms). Allowed: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].org_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization security value of the run. Returned on some tenant database platforms only."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API overview and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response codes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each response with a body includes worked examples; responses without a body say so."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"createddate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation date of the report files, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD-Mon-YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"09-Oct-2026"}],"pointer":"/paths/~1api~1integration~1v1~1reports~1list/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1api~1integration~1v1~1reports~1list/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v1/reports/list","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[],"query":[{"name":"createddate","in":"query","required":true,"example":"09-Oct-2026","schemaId":"schema_3"}],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","502"],"pointer":"/api/integration/v1/reports/list","href":"report-files/listreportfilesbydate","openApiOperationId":"listReportFilesByDate","summary":"List report files by date"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Matching report files."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportFileListResponse","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/200/content/application~1json/examples/files","paths/~1api~1integration~1v1~1reports~1list/get/responses/200/content/application~1json/examples/none"]}},"schemaId":"components/schemas/ReportFileListResponse","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/200/content/application~1json/examples/files","paths/~1api~1integration~1v1~1reports~1list/get/responses/200/content/application~1json/examples/none"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createddate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is missing or not in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD-Mon-YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format, or the OAuth client is not linked to a Zuora user. Also returned when the database connection fails (retry with backoff)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/missing","paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/noUser","paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/dbConnect"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/missing","paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/noUser","paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/dbConnect"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The access token is missing, invalid or expired (gateway), or the OAuth client's user is not a Zuora Revenue user."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1reports~1list/get/responses/401/content/application~1json/examples/noRevenueUser"]}},"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1reports~1list/get/responses/401/content/application~1json/examples/noRevenueUser"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The request was rejected by the Integration service. Either the tenant is not enabled for this API, or the tenant requires custom request headers that were not sent."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1reports~1list/get/responses/403/content/application~1json/examples/customHeaders"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1reports~1list/get/responses/403/content/application~1json/examples/customHeaders"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The file list could not be read. Returned on some tenant database platforms; on others the same condition returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/404/content/application~1json/examples/notFound"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unexpected server or database error. Retry later; if it persists, contact Zuora Support."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/500/content/application~1json/examples/dbError"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/500/content/application~1json/examples/dbError"]},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" An internal query service did not respond correctly. Retry later."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/502/content/application~1json/examples/queryService"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/502/content/application~1json/examples/queryService"]}],"pointer":"/paths/~1api~1integration~1v1~1reports~1list/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportFileListResponse","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/200/content/application~1json/examples/files","paths/~1api~1integration~1v1~1reports~1list/get/responses/200/content/application~1json/examples/none"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportFileListResponse","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/200/content/application~1json/examples/files","paths/~1api~1integration~1v1~1reports~1list/get/responses/200/content/application~1json/examples/none"]}}},{"code":"400","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/missing","paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/noUser","paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/dbConnect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/missing","paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/noUser","paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/dbConnect"]}}},{"code":"401","schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1reports~1list/get/responses/401/content/application~1json/examples/noRevenueUser"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1reports~1list/get/responses/401/content/application~1json/examples/noRevenueUser"]}}},{"code":"403","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1reports~1list/get/responses/403/content/application~1json/examples/customHeaders"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1reports~1list/get/responses/403/content/application~1json/examples/customHeaders"]}}},{"code":"404","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/404/content/application~1json/examples/notFound"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/500/content/application~1json/examples/dbError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/500/content/application~1json/examples/dbError"]}}},{"code":"502","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/502/content/application~1json/examples/queryService"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1list/get/responses/502/content/application~1json/examples/queryService"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-files/listreportfilesbydate"}],"panels":[]}]},"httpPath":"/api/integration/v1/reports/list"},{"label":"Retrieve a report file by submission ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-files/getreportfile","routeSlug":"/other-api/revenue-api-3.0/report-files/getreportfile","metadata":{"seo":{"title":"Retrieve a report file by submission ID","description":"Returns the report file of one run when that run is Available and belongs to an organization your role can access."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReportFile","name":"Retrieve a report file by submission ID","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1reports~1{report_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a report file by submission ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the report file of one run when that run is Available and belongs to an organization your role can access."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Confirm that a run (for example one produced by a report schedule) is ready, and get its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for download."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When you have a submission ID (for example from a schedule notification) and want to check that its file is ready and get its file name."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the submission (run) ID, not the report definition ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the run does not exist, is not Available yet, or is outside your organizations, the response is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array. Poll until the array contains the file."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-files/getreportfile/request/request-definition","deepLinkHash":"/report-files/getreportfile#report-files/getreportfile/request/request-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission (run) identifier."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zuora OneID OAuth)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-files/getreportfile/request/response-definition","deepLinkHash":"/report-files/getreportfile#report-files/getreportfile/request/response-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportFileListResponse"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError or RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportFileListResponse"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Success envelope for the report-file operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the call completed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Message"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional message. Empty on success."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of ReportFile"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Matching Available report files. An empty array means nothing matched."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission identifier of the run that produced the file. Use it with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /reports/{report_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the v2 signed-URL operation."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].file_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the generated file. Use it with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /reports/download/{filename}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].rep_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the report definition that produced the file."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].category"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report category."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].rep_desc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report description."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].layout_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the layout that was run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].report_date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time the run was created, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD-MM-YYYY HH24:MI:SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Run status. These operations only return Available runs, so the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on some tenant database platforms). Allowed: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].org_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization security value of the run. Returned on some tenant database platforms only."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API overview and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response codes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each response with a body includes worked examples; responses without a body say so."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_5","description":"Submission (run) identifier.","required":true,"example":482391}],"pointer":"/paths/~1api~1integration~1v1~1reports~1{report_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1api~1integration~1v1~1reports~1{report_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v1/reports/{report_id}","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"example":482391,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","502"],"pointer":"/api/integration/v1/reports/{report_id}","href":"report-files/getreportfile","openApiOperationId":"getReportFile","summary":"Retrieve a report file by submission ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The report file, or an empty array."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportFileListResponse","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/200/content/application~1json/examples/ready","paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/200/content/application~1json/examples/notReady"]}},"schemaId":"components/schemas/ReportFileListResponse","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/200/content/application~1json/examples/ready","paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/200/content/application~1json/examples/notReady"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The OAuth client is not linked to a Zuora user. Also returned when the database connection fails (retry with backoff)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/400/content/application~1json/examples/noUser","paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/400/content/application~1json/examples/dbConnect"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/400/content/application~1json/examples/noUser","paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/400/content/application~1json/examples/dbConnect"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The access token is missing, invalid or expired (gateway), or the OAuth client's user is not a Zuora Revenue user."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/401/content/application~1json/examples/noRevenueUser"]}},"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/401/content/application~1json/examples/noRevenueUser"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The request was rejected by the Integration service. Either the tenant is not enabled for this API, or the tenant requires custom request headers that were not sent."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/403/content/application~1json/examples/customHeaders"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/403/content/application~1json/examples/customHeaders"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not a non-negative integer (the route does not match and a plain HTML \"Not Found\" page is returned), or, on some tenant database platforms, the data could not be read."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/404/content/application~1json/examples/notFound"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unexpected server or database error. Retry later; if it persists, contact Zuora Support."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/500/content/application~1json/examples/dbError"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/500/content/application~1json/examples/dbError"]},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" An internal query service did not respond correctly. Retry later."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/502/content/application~1json/examples/queryService"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/502/content/application~1json/examples/queryService"]}],"pointer":"/paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportFileListResponse","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/200/content/application~1json/examples/ready","paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/200/content/application~1json/examples/notReady"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportFileListResponse","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/200/content/application~1json/examples/ready","paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/200/content/application~1json/examples/notReady"]}}},{"code":"400","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/400/content/application~1json/examples/noUser","paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/400/content/application~1json/examples/dbConnect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/400/content/application~1json/examples/noUser","paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/400/content/application~1json/examples/dbConnect"]}}},{"code":"401","schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/401/content/application~1json/examples/noRevenueUser"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/401/content/application~1json/examples/noRevenueUser"]}}},{"code":"403","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/403/content/application~1json/examples/customHeaders"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/403/content/application~1json/examples/customHeaders"]}}},{"code":"404","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/404/content/application~1json/examples/notFound"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/500/content/application~1json/examples/dbError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/500/content/application~1json/examples/dbError"]}}},{"code":"502","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/502/content/application~1json/examples/queryService"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/502/content/application~1json/examples/queryService"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-files/getreportfile"}],"panels":[]}]},"httpPath":"/api/integration/v1/reports/{report_id}"},{"label":"List recent report files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-files/listrecentreportfiles","routeSlug":"/other-api/revenue-api-3.0/report-files/listrecentreportfiles","metadata":{"seo":{"title":"List recent report files","description":"Returns up to number_of_records Available report files, sorted by creation time with the newest first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRecentReportFiles","name":"List recent report files","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List recent report files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns up to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number_of_records"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Available report files, sorted by creation time with the newest first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Pick up recently produced files without tracking dates or submission IDs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When you want the latest completed files without tracking dates or submission IDs, for example in a frequent polling job."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keep "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number_of_records"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" small (for example 10 to 50) to keep responses fast."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-files/listrecentreportfiles/request/request-definition","deepLinkHash":"/report-files/listrecentreportfiles#report-files/listrecentreportfiles/request/request-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number_of_records"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum number of files to return."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zuora OneID OAuth)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-files/listrecentreportfiles/request/response-definition","deepLinkHash":"/report-files/listrecentreportfiles#report-files/listrecentreportfiles/request/response-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportFileListResponse"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError or RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ReportFileListResponse"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Success envelope for the report-file operations."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the call completed."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Message"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional message. Empty on success."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"array of ReportFile"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Matching Available report files. An empty array means nothing matched."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission identifier of the run that produced the file. Use it with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /reports/{report_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the v2 signed-URL operation."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].file_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the generated file. Use it with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /reports/download/{filename}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].rep_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the report definition that produced the file."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].category"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report category."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].rep_desc"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report description."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].layout_name"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the layout that was run."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].report_date"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time the run was created, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD-MM-YYYY HH24:MI:SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].status"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Run status. These operations only return Available runs, so the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on some tenant database platforms). Allowed: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result[].org_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization security value of the run. Returned on some tenant database platforms only."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API overview and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response codes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each response with a body includes worked examples; responses without a body say so."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"number_of_records","in":"path","schemaId":"schema_5","description":"Maximum number of files to return.","required":true,"example":10}],"pointer":"/paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v1/reports/recent-n/{number_of_records}","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"number_of_records","in":"path","required":true,"example":10,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","502"],"pointer":"/api/integration/v1/reports/recent-n/{number_of_records}","href":"report-files/listrecentreportfiles","openApiOperationId":"listRecentReportFiles","summary":"List recent report files"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Recent report files."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportFileListResponse","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/200/content/application~1json/examples/recent"]}},"schemaId":"components/schemas/ReportFileListResponse","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/200/content/application~1json/examples/recent"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The OAuth client is not linked to a Zuora user. Also returned when the database connection fails (retry with backoff)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/400/content/application~1json/examples/noUser","paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/400/content/application~1json/examples/dbConnect"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/400/content/application~1json/examples/noUser","paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/400/content/application~1json/examples/dbConnect"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The access token is missing, invalid or expired (gateway), or the OAuth client's user is not a Zuora Revenue user."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/401/content/application~1json/examples/noRevenueUser"]}},"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/401/content/application~1json/examples/noRevenueUser"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The request was rejected by the Integration service. Either the tenant is not enabled for this API, or the tenant requires custom request headers that were not sent."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/403/content/application~1json/examples/customHeaders"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/403/content/application~1json/examples/customHeaders"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number_of_records"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is missing or not a non-negative integer (a plain HTML \"Not Found\" page is returned), or, on some tenant database platforms, the data could not be read."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/404/content/application~1json/examples/notFound"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unexpected server or database error. Retry later; if it persists, contact Zuora Support."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/500/content/application~1json/examples/dbError"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/500/content/application~1json/examples/dbError"]},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" An internal query service did not respond correctly. Retry later."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/502/content/application~1json/examples/queryService"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/502/content/application~1json/examples/queryService"]}],"pointer":"/paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ReportFileListResponse","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/200/content/application~1json/examples/recent"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportFileListResponse","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/200/content/application~1json/examples/recent"]}}},{"code":"400","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/400/content/application~1json/examples/noUser","paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/400/content/application~1json/examples/dbConnect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/400/content/application~1json/examples/noUser","paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/400/content/application~1json/examples/dbConnect"]}}},{"code":"401","schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/401/content/application~1json/examples/noRevenueUser"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/401/content/application~1json/examples/noRevenueUser"]}}},{"code":"403","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/403/content/application~1json/examples/customHeaders"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/403/content/application~1json/examples/customHeaders"]}}},{"code":"404","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/404/content/application~1json/examples/notFound"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/500/content/application~1json/examples/dbError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/500/content/application~1json/examples/dbError"]}}},{"code":"502","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/502/content/application~1json/examples/queryService"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/502/content/application~1json/examples/queryService"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-files/listrecentreportfiles"}],"panels":[]}]},"httpPath":"/api/integration/v1/reports/recent-n/{number_of_records}"},{"label":"Download a report file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-files/downloadreportfile","routeSlug":"/other-api/revenue-api-3.0/report-files/downloadreportfile","metadata":{"seo":{"title":"Download a report file","description":"Streams the bytes of a report file stored in your tenant's Revenue file store. Supports .csv and .zip files."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadReportFile","name":"Download a report file","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1reports~1download~1{filename}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a report file","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Streams the bytes of a report file stored in your tenant's Revenue file store. Supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" files."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Download a file listed by the report-file operations when your tenant stores reports on the Revenue file store. For files in cloud storage, use "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a signed URL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When your tenant stores report files on the Revenue file store and you have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from a list operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the list operations, including its extension."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204 No Content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the file is not in the file store, or its extension is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-files/downloadreportfile/request/request-definition","deepLinkHash":"/report-files/downloadreportfile#report-files/downloadreportfile/request/request-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filename"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File name including extension."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zuora OneID OAuth)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-files/downloadreportfile/request/response-definition","deepLinkHash":"/report-files/downloadreportfile#report-files/downloadreportfile/request/response-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/octet-stream"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (binary)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"none"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No body"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError or RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API overview and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response codes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each response with a body includes worked examples; responses without a body say so."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"filename","in":"path","schemaId":"schema_3","description":"File name including extension.","required":true,"example":"WF_SUMMARY_482391.csv"}],"pointer":"/paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v1/reports/download/{filename}","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"filename","in":"path","required":true,"example":"WF_SUMMARY_482391.csv","schemaId":"schema_3"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","204","400","401","403","429","500","502"],"pointer":"/api/integration/v1/reports/download/{filename}","href":"report-files/downloadreportfile","openApiOperationId":"downloadReportFile","summary":"Download a report file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The file contents."},"children":[]}]}]}],"mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_33","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/200/content/application~1octet-stream/examples/csv"]}},"schemaId":"schema_33","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/200/content/application~1octet-stream/examples/csv"]},{"code":"204","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The file does not exist in the file store, or it is not a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".zip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file. No body."},"children":[]}]}]}]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The tenant's file store could not be resolved or read, or the OAuth client is not linked to a Zuora user. Also returned when the database connection fails (retry with backoff)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/noPath","paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/noUser","paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/dbConnect"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/noPath","paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/noUser","paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/dbConnect"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The access token is missing, invalid or expired (gateway), or the OAuth client's user is not a Zuora Revenue user."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/401/content/application~1json/examples/noRevenueUser"]}},"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/401/content/application~1json/examples/noRevenueUser"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The request was rejected by the Integration service. Either the tenant is not enabled for this API, or the tenant requires custom request headers that were not sent."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/403/content/application~1json/examples/customHeaders"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/403/content/application~1json/examples/customHeaders"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unexpected server or database error. Retry later; if it persists, contact Zuora Support."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/500/content/application~1json/examples/dbError"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/500/content/application~1json/examples/dbError"]},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" An internal query service did not respond correctly. Retry later."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/502/content/application~1json/examples/queryService"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/502/content/application~1json/examples/queryService"]}],"pointer":"/paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_33","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/200/content/application~1octet-stream/examples/csv"],"mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"schema_33","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/200/content/application~1octet-stream/examples/csv"]}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/noPath","paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/noUser","paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/dbConnect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/noPath","paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/noUser","paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/dbConnect"]}}},{"code":"401","schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/401/content/application~1json/examples/noRevenueUser"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/401/content/application~1json/examples/noRevenueUser"]}}},{"code":"403","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/403/content/application~1json/examples/customHeaders"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/403/content/application~1json/examples/customHeaders"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/500/content/application~1json/examples/dbError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/500/content/application~1json/examples/dbError"]}}},{"code":"502","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/502/content/application~1json/examples/queryService"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/502/content/application~1json/examples/queryService"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-files/downloadreportfile"}],"panels":[]}]},"httpPath":"/api/integration/v1/reports/download/{filename}"},{"label":"Retrieve a signed URL","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-files/getreportsignedurl","routeSlug":"/other-api/revenue-api-3.0/report-files/getreportsignedurl","metadata":{"seo":{"title":"Retrieve a signed URL","description":"Returns a signed HTTPS URL, valid for 30 minutes, for the file of an Available run stored in cloud storage. Download the file with a plain HTTP GET on the URL. GET and POST behave the same; POST takes no body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReportSignedUrl","name":"Retrieve a signed URL","isWebhook":false,"pointer":"/paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a signed URL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a signed HTTPS URL, valid for 30 minutes, for the file of an Available run stored in cloud storage. Download the file with a plain HTTP GET on the URL. GET and POST behave the same; POST takes no body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The recommended way to download report files: large files do not pass through the API and the URL expires quickly if it is leaked."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To download a completed report file that is stored in cloud storage. This is the preferred download method for the Integration Reporting APIs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the submission (run) ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some tenants disable HTTP GET on this operation. In that case GET returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and you must use POST on the same path. POST always works, so prefer POST in new integrations."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-files/getreportsignedurl/request/request-definition","deepLinkHash":"/report-files/getreportsignedurl#report-files/getreportsignedurl/request/request-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission (run) identifier."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zuora OneID OAuth)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-files/getreportsignedurl/request/response-definition","deepLinkHash":"/report-files/getreportsignedurl#report-files/getreportsignedurl/request/response-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SignedUrlResponse"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError or RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SignedUrlError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SignedUrlResponse"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signed download URL for a completed report."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the URL was generated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signed_url"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (uri)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTPS URL of the report file. Download it with a plain HTTP GET; it is valid for 30 minutes (1,800 seconds)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API overview and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response codes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each response with a body includes worked examples; responses without a body say so."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_5","description":"Submission (run) identifier.","required":true,"example":482391}],"pointer":"/paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v2/reports/signedurl/{report_id}","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"example":482391,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","502"],"pointer":"/api/integration/v2/reports/signedurl/{report_id}","href":"report-files/getreportsignedurl","openApiOperationId":"getReportSignedUrl","summary":"Retrieve a signed URL"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The signed URL."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignedUrlResponse","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/200/content/application~1json/examples/url"]}},"schemaId":"components/schemas/SignedUrlResponse","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/200/content/application~1json/examples/url"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The signing service returned an error, or an unexpected error occurred. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds the error text. Retry once, then contact Zuora Support with the submission ID. Also returned when the database connection fails (retry with backoff)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/400/content/application~1json/examples/signing","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/400/content/application~1json/examples/dbConnect"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/400/content/application~1json/examples/signing","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/400/content/application~1json/examples/dbConnect"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The access token is missing, invalid or expired (gateway), or the OAuth client's user is not a Zuora Revenue user."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/401/content/application~1json/examples/noRevenueUser"]}},"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/401/content/application~1json/examples/noRevenueUser"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP GET is disabled for the tenant (use POST), the tenant is not enabled for this API, or required custom headers are missing."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/403/content/application~1json/examples/getDisabled","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/403/content/application~1json/examples/restricted"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/403/content/application~1json/examples/getDisabled","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/403/content/application~1json/examples/restricted"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The run was not found, is not Available, or its file is not in cloud storage (use Download a report file instead), or URL signing is not configured for the tenant."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignedUrlError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/404/content/application~1json/examples/notFound","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/404/content/application~1json/examples/notConfigured"]}},"schemaId":"components/schemas/SignedUrlError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/404/content/application~1json/examples/notFound","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/404/content/application~1json/examples/notConfigured"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unexpected server or database error. Retry later; if it persists, contact Zuora Support."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/500/content/application~1json/examples/dbError"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/500/content/application~1json/examples/dbError"]},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" An internal query service did not respond correctly. Retry later."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/502/content/application~1json/examples/queryService"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/502/content/application~1json/examples/queryService"]}],"pointer":"/paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SignedUrlResponse","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/200/content/application~1json/examples/url"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignedUrlResponse","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/200/content/application~1json/examples/url"]}}},{"code":"400","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/400/content/application~1json/examples/signing","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/400/content/application~1json/examples/dbConnect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/400/content/application~1json/examples/signing","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/400/content/application~1json/examples/dbConnect"]}}},{"code":"401","schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/401/content/application~1json/examples/noRevenueUser"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/401/content/application~1json/examples/noRevenueUser"]}}},{"code":"403","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/403/content/application~1json/examples/getDisabled","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/403/content/application~1json/examples/restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/403/content/application~1json/examples/getDisabled","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/403/content/application~1json/examples/restricted"]}}},{"code":"404","schemaId":"components/schemas/SignedUrlError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/404/content/application~1json/examples/notFound","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/404/content/application~1json/examples/notConfigured"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignedUrlError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/404/content/application~1json/examples/notFound","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/404/content/application~1json/examples/notConfigured"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/500/content/application~1json/examples/dbError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/500/content/application~1json/examples/dbError"]}}},{"code":"502","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/502/content/application~1json/examples/queryService"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/502/content/application~1json/examples/queryService"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-files/getreportsignedurl"}],"panels":[]}]},"httpPath":"/api/integration/v2/reports/signedurl/{report_id}"},{"label":"Get a signed URL (POST)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/report-files/getreportsignedurlpost","routeSlug":"/other-api/revenue-api-3.0/report-files/getreportsignedurlpost","metadata":{"seo":{"title":"Get a signed URL (POST)","description":"Returns a signed HTTPS URL, valid for 30 minutes, for the file of an Available run stored in cloud storage. Download the file with a plain HTTP GET on the URL. GET and POST behave the same; POST takes no body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReportSignedUrlPost","name":"Get a signed URL (POST)","isWebhook":false,"pointer":"/paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a signed URL (POST)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a signed HTTPS URL, valid for 30 minutes, for the file of an Available run stored in cloud storage. Download the file with a plain HTTP GET on the URL. GET and POST behave the same; POST takes no body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The recommended way to download report files: large files do not pass through the API and the URL expires quickly if it is leaked."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" To download a completed report file that is stored in cloud storage. This is the preferred download method for the Integration Reporting APIs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the submission (run) ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Some tenants disable HTTP GET on this operation. In that case GET returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and you must use POST on the same path. POST always works, so prefer POST in new integrations."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-files/getreportsignedurlpost/request/request-definition","deepLinkHash":"/report-files/getreportsignedurlpost#report-files/getreportsignedurlpost/request/request-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"path"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission (run) identifier."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Zuora-Track-Id"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"header"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Yes"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Zuora OneID OAuth)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"report-files/getreportsignedurlpost/request/response-definition","deepLinkHash":"/report-files/getreportsignedurlpost#report-files/getreportsignedurlpost/request/response-definition"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response definition"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP status"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Content type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SignedUrlResponse"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError or RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SignedUrlError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GatewayError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RiaError"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SignedUrlResponse"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Signed download URL for a completed report."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the URL was generated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signed_url"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string (uri)"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTPS URL of the report file. Download it with a plain HTTP GET; it is valid for 30 minutes (1,800 seconds)."},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas (GatewayError, ServiceError, SpringError, SimpleError, MissingFiltersError, RunStatusConflict, RiaError, SignedUrlError) are defined once under "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error response schemas"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the API overview and in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"components/schemas"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response codes:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"401"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"429"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"502"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Each response with a body includes worked examples; responses without a body say so."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"report_id","in":"path","schemaId":"schema_5","description":"Submission (run) identifier.","required":true,"example":482391}],"pointer":"/paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/integration/v2/reports/signedurl/{report_id}","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"report_id","in":"path","required":true,"example":482391,"schemaId":"schema_5"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500","502"],"pointer":"/api/integration/v2/reports/signedurl/{report_id}","href":"report-files/getreportsignedurlpost","openApiOperationId":"getReportSignedUrlPost","summary":"Get a signed URL (POST)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration Reporting paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The signed URL."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignedUrlResponse","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/200/content/application~1json/examples/url"]}},"schemaId":"components/schemas/SignedUrlResponse","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/200/content/application~1json/examples/url"]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The signing service returned an error, or an unexpected error occurred. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds the error text. Retry once, then contact Zuora Support with the submission ID. Also returned when the database connection fails (retry with backoff)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/400/content/application~1json/examples/signing","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/400/content/application~1json/examples/dbConnect"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/400/content/application~1json/examples/signing","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/400/content/application~1json/examples/dbConnect"]},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The access token is missing, invalid or expired (gateway), or the OAuth client's user is not a Zuora Revenue user."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/401/content/application~1json/examples/noRevenueUser"]}},"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/401/content/application~1json/examples/noRevenueUser"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" HTTP GET is disabled for the tenant (use POST), the tenant is not enabled for this API, or required custom headers are missing."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/403/content/application~1json/examples/getDisabled","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/403/content/application~1json/examples/restricted"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/403/content/application~1json/examples/getDisabled","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/403/content/application~1json/examples/restricted"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The run was not found, is not Available, or its file is not in cloud storage (use Download a report file instead), or URL signing is not configured for the tenant."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignedUrlError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/404/content/application~1json/examples/notFound","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/404/content/application~1json/examples/notConfigured"]}},"schemaId":"components/schemas/SignedUrlError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/404/content/application~1json/examples/notFound","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/404/content/application~1json/examples/notConfigured"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Unexpected server or database error. Retry later; if it persists, contact Zuora Support."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/500/content/application~1json/examples/dbError"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/500/content/application~1json/examples/dbError"]},{"code":"502","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" An internal query service did not respond correctly. Retry later."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/502/content/application~1json/examples/queryService"]}},"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/502/content/application~1json/examples/queryService"]}],"pointer":"/paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SignedUrlResponse","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/200/content/application~1json/examples/url"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignedUrlResponse","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/200/content/application~1json/examples/url"]}}},{"code":"400","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/400/content/application~1json/examples/signing","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/400/content/application~1json/examples/dbConnect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/400/content/application~1json/examples/signing","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/400/content/application~1json/examples/dbConnect"]}}},{"code":"401","schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/401/content/application~1json/examples/noRevenueUser"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/401/content/application~1json/examples/noRevenueUser"]}}},{"code":"403","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/403/content/application~1json/examples/getDisabled","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/403/content/application~1json/examples/restricted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/403/content/application~1json/examples/getDisabled","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/403/content/application~1json/examples/restricted"]}}},{"code":"404","schemaId":"components/schemas/SignedUrlError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/404/content/application~1json/examples/notFound","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/404/content/application~1json/examples/notConfigured"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SignedUrlError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/404/content/application~1json/examples/notFound","paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/404/content/application~1json/examples/notConfigured"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/500/content/application~1json/examples/dbError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/500/content/application~1json/examples/dbError"]}}},{"code":"502","schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/502/content/application~1json/examples/queryService"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ReportingRiaError","exampleIds":["paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/502/content/application~1json/examples/queryService"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/report-files/getreportsignedurlpost"}],"panels":[]}]},"httpPath":"/api/integration/v2/reports/signedurl/{report_id}"}],"content":{"contentType":"group","meta":{"name":"Report Files"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Report Files","showPageActions":true},{"nodeType":"markdoc","content":"List completed report files and download them through the Integration service."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/integration/v1/reports/list","summary":"List report files by date","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-files/listreportfilesbydate","deprecated":false},{"title":"/api/integration/v1/reports/{report_id}","summary":"Retrieve a report file by submission ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-files/getreportfile","deprecated":false},{"title":"/api/integration/v1/reports/recent-n/{number_of_records}","summary":"List recent report files","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-files/listrecentreportfiles","deprecated":false},{"title":"/api/integration/v1/reports/download/{filename}","summary":"Download a report file","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-files/downloadreportfile","deprecated":false},{"title":"/api/integration/v2/reports/signedurl/{report_id}","summary":"Retrieve a signed URL","prefix":{"name":"get","color":"get"},"badges":[],"link":"/report-files/getreportsignedurl","deprecated":false},{"title":"/api/integration/v2/reports/signedurl/{report_id}","summary":"Get a signed URL (POST)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/report-files/getreportsignedurlpost","deprecated":false}]}]}]}]}},{"type":"separator","label":"BI Views","content":null},{"type":"group","label":"BI Views","link":"/other-api/revenue-api-3.0/bi-views","routeSlug":"/other-api/revenue-api-3.0/bi-views","items":[{"label":"Retrieve BI View data (v2, paged)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-views/getbiviewdatav2","routeSlug":"/other-api/revenue-api-3.0/bi-views/getbiviewdatav2","metadata":{"seo":{"title":"Retrieve BI View data (v2, paged)","description":"Returns one page of BI View rows for a date range as CSV or gzip-compressed CSV. Page 1 starts a background task that writes all pages; the response carries a continuation-token header that you send to read pages 2, 3 and so on. Use POST with a Fields body to return only selected columns."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBiViewDataV2","name":"Retrieve BI View data (v2, paged)","isWebhook":false,"pointer":"/paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve BI View data (v2, paged)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns one page of BI View rows for a date range as CSV or gzip-compressed CSV. Page 1 starts a background task that writes all pages; the response carries a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuation-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header that you send to read pages 2, 3 and so on. Use POST with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body to return only selected columns."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Extract large volumes of Zuora Revenue data (contracts, lines, schedules, bills, journal data) into a data warehouse or reconciliation process efficiently."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-ddTHH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and filter on the view's incremental update date ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCR_UPDT_DT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), so consecutive ranges give you incremental (changed-data) extracts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagenum=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" first without a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuation-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For every later page, send the token from the page 1 response. Increase "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagenum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until the response is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (\"This page will not exist\"), which also tells you the total pages and rows."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" maximum: 10,000 rows for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and 20,000 rows for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (your tenant may have lower limits)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagenum=0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204 No Content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_LINE_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_EVENT_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are optional when you filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Always send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagenum=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or higher); without it the response is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A later page can return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \"Page still not yet cached. Please retry.\" while the background task is still writing it. Wait a few seconds and retry; check the task with Get a BI View task if it keeps happening."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" output is returned with content type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rows are limited to the organizations your role can access."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tmpl_name","in":"path","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BI View API name. Standard views: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_ACCT_TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_APPR_DTL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_BOOK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_CALENDAR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_MJE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_ORG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_PERIODS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_BILL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_HEAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LNS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LN_COST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_POB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_SCHD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_SCHD_DEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RI_ACCT_SUMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_LINE_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_EVENT_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_CT_MOD_DETAIL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LNS_VERSION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_POB_ACTIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_CT_MOD_DET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_HOLD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom views configured for your tenant are also accepted."},"children":[]}]}]}],"required":true,"example":"BI3_RC_LNS"}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromDate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the date range, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-ddTHH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"2026-09-01T00:00:00"},{"name":"toDate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End of the date range, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-ddTHH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"2026-09-30T23:59:59"},{"name":"pagenum","in":"query","schemaId":"schema_5","description":"Page to return, starting at 1.","required":true,"example":1},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Rows per page.","example":5000},{"name":"outputType","in":"query","schemaId":"schema_35","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (gzip-compressed CSV) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"csv"},{"name":"max_pages","in":"query","schemaId":"schema_34","description":"Maximum number of pages the background task prepares.","example":100},{"name":"add_record_count","in":"query","schemaId":"schema_36","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to have the task count the rows first. Slower on large views. Omit the parameter to turn counting off: any non-empty value, including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", turns it on."},"children":[]}]}]}],"example":true},{"name":"batchId","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch identifier. Used only by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_LINE_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_EVENT_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where it replaces the date range filter."},"children":[]}]}]}],"example":"20260930001"},{"name":"clientId","in":"query","schemaId":"schema_5","description":"Accepted for compatibility with v1. Not used by v2.","example":1}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"continuation-token","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task identifier returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuation-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header of page 1. Required for every page after the first."},"children":[]}]}]}],"example":"3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4"},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v2/biviews/{tmpl_name}","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"tmpl_name","in":"path","required":true,"example":"BI3_RC_LNS","schemaId":"schema_3"}],"query":[{"name":"fromDate","in":"query","required":true,"example":"2026-09-01T00:00:00","schemaId":"schema_3"},{"name":"toDate","in":"query","required":true,"example":"2026-09-30T23:59:59","schemaId":"schema_3"},{"name":"pagenum","in":"query","required":true,"example":1,"schemaId":"schema_5"},{"name":"pageSize","in":"query","required":false,"example":5000,"schemaId":"schema_34"},{"name":"outputType","in":"query","required":false,"example":"csv","schemaId":"schema_35"},{"name":"max_pages","in":"query","required":false,"example":100,"schemaId":"schema_34"},{"name":"add_record_count","in":"query","required":false,"example":true,"schemaId":"schema_36"},{"name":"batchId","in":"query","required":false,"example":"20260930001","schemaId":"schema_3"},{"name":"clientId","in":"query","required":false,"example":1,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"continuation-token","in":"header","required":false,"example":"3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4","schemaId":"schema_3"},{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","204","400","401","403","404","429","500","502"],"pointer":"/api/integration/v2/biviews/{tmpl_name}","href":"bi-views/getbiviewdatav2","openApiOperationId":"getBiViewDataV2","summary":"Retrieve BI View data (v2, paged)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One page of rows. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuation-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header identifies the background task; send it on the next page."},"children":[]}]}]}],"mediaType":"text/csv","mediaTypes":["text/csv","application/gzip"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_3","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/200/content/text~1csv/examples/csvPage"]},"application/gzip":{"schemaId":"schema_33","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/200/content/application~1gzip/examples/gzipPage"]}},"schemaId":"schema_3","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/200/content/text~1csv/examples/csvPage"],"headers":{"continuation-token":{"description":"Task identifier to send when requesting later pages.","schema":{"type":"string"}}},"headerSchemaId":"schema_37"},{"code":"204","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagenum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 0. No body."},"children":[]}]}]}]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A parameter is missing or invalid, a later page was requested without a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuation-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is above the limit, a selected field does not exist, the view name is unknown, or the tenant's query quota is used up. Also returned when the database connection fails (retry with backoff)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/missingParam","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/noToken","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/pageSize","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badField","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/notCached","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/quota","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/missingParam","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/noToken","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/pageSize","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badField","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/notCached","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/quota","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect"]},{"code":"401","description":"The access token is missing, invalid or expired (gateway), or the OAuth client's user is not a Zuora Revenue user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser"]}},"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser"]},{"code":"403","description":"The request was rejected by the Integration service. Either the tenant is not enabled for this API, or the tenant requires custom request headers that were not sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested page is beyond the last page. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" gives the total pages and rows. Stop paging."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/404/content/application~1json/examples/lastPage"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/404/content/application~1json/examples/lastPage"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":"The background worker was interrupted, or an unexpected error occurred. Retry page 1.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/500/content/application~1json/examples/worker"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/500/content/application~1json/examples/worker"],"headers":{"continuation-token":{"description":"Task identifier of the interrupted task.","schema":{"type":"string"}}},"headerSchemaId":"schema_39"},{"code":"502","description":"An internal query service did not respond correctly. Retry later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService"]}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_3","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/200/content/text~1csv/examples/csvPage"],"mediaTypes":["text/csv","application/gzip"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_3","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/200/content/text~1csv/examples/csvPage"]},"application/gzip":{"schemaId":"schema_33","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/200/content/application~1gzip/examples/gzipPage"]}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/missingParam","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/noToken","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/pageSize","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badField","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/notCached","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/quota","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/missingParam","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/noToken","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/pageSize","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badField","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/notCached","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/quota","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect"]}}},{"code":"401","schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser"]}}},{"code":"403","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders"]}}},{"code":"404","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/404/content/application~1json/examples/lastPage"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/404/content/application~1json/examples/lastPage"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/500/content/application~1json/examples/worker"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/500/content/application~1json/examples/worker"]}}},{"code":"502","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bi-views/getbiviewdatav2"}],"panels":[]}]},"httpPath":"/api/integration/v2/biviews/{tmpl_name}"},{"label":"Get BI View data (v2, paged) (POST)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-views/getbiviewdatav2post","routeSlug":"/other-api/revenue-api-3.0/bi-views/getbiviewdatav2post","metadata":{"seo":{"title":"Get BI View data (v2, paged) (POST)","description":"Returns one page of BI View rows for a date range as CSV or gzip-compressed CSV. Page 1 starts a background task that writes all pages; the response carries a continuation-token header that you send to read pages 2, 3 and so on. Use POST with a Fields body to return only selected columns."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBiViewDataV2Post","name":"Get BI View data (v2, paged) (POST)","isWebhook":false,"pointer":"/paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get BI View data (v2, paged) (POST)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns one page of BI View rows for a date range as CSV or gzip-compressed CSV. Page 1 starts a background task that writes all pages; the response carries a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuation-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header that you send to read pages 2, 3 and so on. Use POST with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body to return only selected columns."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Extract large volumes of Zuora Revenue data (contracts, lines, schedules, bills, journal data) into a data warehouse or reconciliation process efficiently."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-ddTHH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and filter on the view's incremental update date ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCR_UPDT_DT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), so consecutive ranges give you incremental (changed-data) extracts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagenum=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" first without a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuation-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For every later page, send the token from the page 1 response. Increase "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagenum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until the response is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"404"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (\"This page will not exist\"), which also tells you the total pages and rows."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" maximum: 10,000 rows for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and 20,000 rows for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (your tenant may have lower limits)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagenum=0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204 No Content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_LINE_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_EVENT_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are optional when you filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Always send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagenum=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or higher); without it the response is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A later page can return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \"Page still not yet cached. Please retry.\" while the background task is still writing it. Wait a few seconds and retry; check the task with Get a BI View task if it keeps happening."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" output is returned with content type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rows are limited to the organizations your role can access."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tmpl_name","in":"path","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BI View API name. Standard views: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_ACCT_TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_APPR_DTL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_BOOK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_CALENDAR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_MJE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_ORG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_PERIODS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_BILL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_HEAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LNS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LN_COST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_POB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_SCHD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_SCHD_DEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RI_ACCT_SUMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_LINE_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_EVENT_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_CT_MOD_DETAIL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LNS_VERSION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_POB_ACTIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_CT_MOD_DET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_HOLD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom views configured for your tenant are also accepted."},"children":[]}]}]}],"required":true,"example":"BI3_RC_LNS"}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromDate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the date range, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-ddTHH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"2026-09-01T00:00:00"},{"name":"toDate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End of the date range, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-ddTHH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"2026-09-30T23:59:59"},{"name":"pagenum","in":"query","schemaId":"schema_5","description":"Page to return, starting at 1.","required":true,"example":1},{"name":"pageSize","in":"query","schemaId":"schema_34","description":"Rows per page.","example":5000},{"name":"outputType","in":"query","schemaId":"schema_35","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gzip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (gzip-compressed CSV) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"csv"},{"name":"max_pages","in":"query","schemaId":"schema_34","description":"Maximum number of pages the background task prepares.","example":100},{"name":"add_record_count","in":"query","schemaId":"schema_36","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to have the task count the rows first. Slower on large views. Omit the parameter to turn counting off: any non-empty value, including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", turns it on."},"children":[]}]}]}],"example":true},{"name":"batchId","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Batch identifier. Used only by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_LINE_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_EVENT_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", where it replaces the date range filter."},"children":[]}]}]}],"example":"20260930001"},{"name":"clientId","in":"query","schemaId":"schema_5","description":"Accepted for compatibility with v1. Not used by v2.","example":1}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"continuation-token","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task identifier returned in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuation-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header of page 1. Required for every page after the first."},"children":[]}]}]}],"example":"3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4"},{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/fields","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/array"]}},"schemaId":"schema_40","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/fields","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/array"],"pointer":"/paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/requestBody","description":"POST only. Columns to return. Omit to return all columns."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/integration/v2/biviews/{tmpl_name}","servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"tmpl_name","in":"path","required":true,"example":"BI3_RC_LNS","schemaId":"schema_3"}],"query":[{"name":"fromDate","in":"query","required":true,"example":"2026-09-01T00:00:00","schemaId":"schema_3"},{"name":"toDate","in":"query","required":true,"example":"2026-09-30T23:59:59","schemaId":"schema_3"},{"name":"pagenum","in":"query","required":true,"example":1,"schemaId":"schema_5"},{"name":"pageSize","in":"query","required":false,"example":5000,"schemaId":"schema_34"},{"name":"outputType","in":"query","required":false,"example":"csv","schemaId":"schema_35"},{"name":"max_pages","in":"query","required":false,"example":100,"schemaId":"schema_34"},{"name":"add_record_count","in":"query","required":false,"example":true,"schemaId":"schema_36"},{"name":"batchId","in":"query","required":false,"example":"20260930001","schemaId":"schema_3"},{"name":"clientId","in":"query","required":false,"example":1,"schemaId":"schema_5"}],"querystring":[],"header":[{"name":"continuation-token","in":"header","required":false,"example":"3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4","schemaId":"schema_3"},{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/fields","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/array"]}},"responseCodes":["200","204","400","401","403","404","429","500","502"],"pointer":"/api/integration/v2/biviews/{tmpl_name}","href":"bi-views/getbiviewdatav2post","openApiOperationId":"getBiViewDataV2Post","summary":"Get BI View data (v2, paged) (POST)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"schemaId":"schema_40","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/fields","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/array"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/fields","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/array"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One page of rows. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuation-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header identifies the background task; send it on the next page."},"children":[]}]}]}],"mediaType":"text/csv","mediaTypes":["text/csv","application/gzip"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_3","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/200/content/text~1csv/examples/csvPage"]},"application/gzip":{"schemaId":"schema_33","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/200/content/application~1gzip/examples/gzipPage"]}},"schemaId":"schema_3","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/200/content/text~1csv/examples/csvPage"],"headers":{"continuation-token":{"description":"Task identifier to send when requesting later pages.","schema":{"type":"string"}}},"headerSchemaId":"schema_37"},{"code":"204","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagenum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 0. No body."},"children":[]}]}]}]},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A parameter is missing or invalid, a later page was requested without a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuation-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is above the limit, a selected field does not exist, the view name is unknown, or the tenant's query quota is used up. Also returned when the database connection fails (retry with backoff)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/missingParam","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/noToken","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/pageSize","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badField","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/notCached","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/quota","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dbConnect"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/missingParam","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/noToken","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/pageSize","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badField","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/notCached","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/quota","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dbConnect"]},{"code":"401","description":"The access token is missing, invalid or expired (gateway), or the OAuth client's user is not a Zuora Revenue user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/noRevenueUser"]}},"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/noRevenueUser"]},{"code":"403","description":"The request was rejected by the Integration service. Either the tenant is not enabled for this API, or the tenant requires custom request headers that were not sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/customHeaders"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/customHeaders"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The requested page is beyond the last page. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" gives the total pages and rows. Stop paging."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/404/content/application~1json/examples/lastPage"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/404/content/application~1json/examples/lastPage"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":"The background worker was interrupted, or an unexpected error occurred. Retry page 1.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/500/content/application~1json/examples/worker"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/500/content/application~1json/examples/worker"],"headers":{"continuation-token":{"description":"Task identifier of the interrupted task.","schema":{"type":"string"}}},"headerSchemaId":"schema_39"},{"code":"502","description":"An internal query service did not respond correctly. Retry later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/502/content/application~1json/examples/queryService"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/502/content/application~1json/examples/queryService"]}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_3","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/200/content/text~1csv/examples/csvPage"],"mediaTypes":["text/csv","application/gzip"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_3","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/200/content/text~1csv/examples/csvPage"]},"application/gzip":{"schemaId":"schema_33","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/200/content/application~1gzip/examples/gzipPage"]}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/missingParam","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/noToken","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/pageSize","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badField","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/notCached","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/quota","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dbConnect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/missingParam","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/noToken","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/pageSize","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badField","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/notCached","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/quota","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dbConnect"]}}},{"code":"401","schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/noRevenueUser"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/noRevenueUser"]}}},{"code":"403","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/customHeaders"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/customHeaders"]}}},{"code":"404","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/404/content/application~1json/examples/lastPage"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/404/content/application~1json/examples/lastPage"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/500/content/application~1json/examples/worker"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/500/content/application~1json/examples/worker"]}}},{"code":"502","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/502/content/application~1json/examples/queryService"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/502/content/application~1json/examples/queryService"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bi-views/getbiviewdatav2post"}],"panels":[]}]},"httpPath":"/api/integration/v2/biviews/{tmpl_name}"},{"label":"Count BI View rows","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-views/countbiviewrowsv2","routeSlug":"/other-api/revenue-api-3.0/bi-views/countbiviewrowsv2","metadata":{"seo":{"title":"Count BI View rows","description":"Returns the number of rows in a BI View for a date range, limited to the organizations your role can access."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"countBiViewRowsV2","name":"Count BI View rows","isWebhook":false,"pointer":"/paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Count BI View rows","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the number of rows in a BI View for a date range, limited to the organizations your role can access."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Size an extraction before you start it, choose a page size, and reconcile the rows you loaded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Counting a large view over a wide range can take a while; narrow the date range where you can."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tmpl_name","in":"path","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BI View API name. Standard views: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_ACCT_TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_APPR_DTL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_BOOK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_CALENDAR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_MJE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_ORG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_PERIODS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_BILL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_HEAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LNS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LN_COST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_POB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_SCHD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_SCHD_DEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RI_ACCT_SUMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_LINE_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_EVENT_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_CT_MOD_DETAIL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LNS_VERSION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_POB_ACTIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_CT_MOD_DET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_HOLD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom views configured for your tenant are also accepted."},"children":[]}]}]}],"required":true,"example":"BI3_RC_LNS"}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromDate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the date range, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-ddTHH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"2026-09-01T00:00:00"},{"name":"toDate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End of the date range, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-ddTHH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"2026-09-30T23:59:59"}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v2/biviews/count/{tmpl_name}","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"tmpl_name","in":"path","required":true,"example":"BI3_RC_LNS","schemaId":"schema_3"}],"query":[{"name":"fromDate","in":"query","required":true,"example":"2026-09-01T00:00:00","schemaId":"schema_3"},{"name":"toDate","in":"query","required":true,"example":"2026-09-30T23:59:59","schemaId":"schema_3"}],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","502"],"pointer":"/api/integration/v2/biviews/count/{tmpl_name}","href":"bi-views/countbiviewrowsv2","openApiOperationId":"countBiViewRowsV2","summary":"Count BI View rows"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The row count.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BiViewCount","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/200/content/application~1json/examples/count"]}},"schemaId":"components/schemas/BiViewCount","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/200/content/application~1json/examples/count"]},{"code":"400","description":"A date is missing or invalid, the view name is unknown, or the count failed. Also returned when the database connection fails (retry with backoff).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/missingParam","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/missingParam","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect"]},{"code":"401","description":"The access token is missing, invalid or expired (gateway), or the OAuth client's user is not a Zuora Revenue user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser"]}},"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser"]},{"code":"403","description":"The request was rejected by the Integration service. Either the tenant is not enabled for this API, or the tenant requires custom request headers that were not sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":"Unexpected server or database error. Retry later; if it persists, contact Zuora Support.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/500/content/application~1json/examples/dbError"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/500/content/application~1json/examples/dbError"]},{"code":"502","description":"An internal query service did not respond correctly. Retry later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService"]}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BiViewCount","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/200/content/application~1json/examples/count"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BiViewCount","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/200/content/application~1json/examples/count"]}}},{"code":"400","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/missingParam","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/missingParam","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect"]}}},{"code":"401","schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser"]}}},{"code":"403","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/500/content/application~1json/examples/dbError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/500/content/application~1json/examples/dbError"]}}},{"code":"502","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bi-views/countbiviewrowsv2"}],"panels":[]}]},"httpPath":"/api/integration/v2/biviews/count/{tmpl_name}"},{"label":"List BI View columns","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-views/describebiviewcolumnsv2","routeSlug":"/other-api/revenue-api-3.0/bi-views/describebiviewcolumnsv2","metadata":{"seo":{"title":"List BI View columns","description":"Returns the columns of a BI View with their data types and sizes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"describeBiViewColumnsV2","name":"List BI View columns","isWebhook":false,"pointer":"/paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List BI View columns","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the columns of a BI View with their data types and sizes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Build target tables in your warehouse and choose the column names to send in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tmpl_name","in":"path","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BI View API name. Standard views: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_ACCT_TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_APPR_DTL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_BOOK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_CALENDAR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_MJE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_ORG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_PERIODS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_BILL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_HEAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LNS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LN_COST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_POB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_SCHD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_SCHD_DEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RI_ACCT_SUMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_LINE_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_EVENT_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_CT_MOD_DETAIL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LNS_VERSION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_POB_ACTIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_CT_MOD_DET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_HOLD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom views configured for your tenant are also accepted."},"children":[]}]}]}],"required":true,"example":"BI3_RC_HEAD"}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v2/biviews/{tmpl_name}/describe-columns","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"tmpl_name","in":"path","required":true,"example":"BI3_RC_HEAD","schemaId":"schema_3"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","204","400","401","403","429","500","502"],"pointer":"/api/integration/v2/biviews/{tmpl_name}/describe-columns","href":"bi-views/describebiviewcolumnsv2","openApiOperationId":"describeBiViewColumnsV2","summary":"List BI View columns"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The columns of the view, as JSON text (served with content type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; parse the body as JSON)."},"children":[]}]}]}],"mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_41","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/200/content/text~1html/examples/columns"]}},"schemaId":"schema_41","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/200/content/text~1html/examples/columns"]},{"code":"204","description":"No column information is available for the view. No body."},{"code":"400","description":"The view name is unknown. Also returned when the database connection fails (retry with backoff).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/400/content/application~1json/examples/dbConnect"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/400/content/application~1json/examples/dbConnect"]},{"code":"401","description":"The access token is missing, invalid or expired (gateway), or the OAuth client's user is not a Zuora Revenue user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/401/content/application~1json/examples/noRevenueUser"]}},"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/401/content/application~1json/examples/noRevenueUser"]},{"code":"403","description":"The request was rejected by the Integration service. Either the tenant is not enabled for this API, or the tenant requires custom request headers that were not sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/403/content/application~1json/examples/customHeaders"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/403/content/application~1json/examples/customHeaders"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":"Unexpected server or database error. Retry later; if it persists, contact Zuora Support.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/500/content/application~1json/examples/dbError"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/500/content/application~1json/examples/dbError"]},{"code":"502","description":"An internal query service did not respond correctly. Retry later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/502/content/application~1json/examples/queryService"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/502/content/application~1json/examples/queryService"]}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_41","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/200/content/text~1html/examples/columns"],"mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_41","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/200/content/text~1html/examples/columns"]}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/400/content/application~1json/examples/dbConnect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/400/content/application~1json/examples/dbConnect"]}}},{"code":"401","schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/401/content/application~1json/examples/noRevenueUser"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/401/content/application~1json/examples/noRevenueUser"]}}},{"code":"403","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/403/content/application~1json/examples/customHeaders"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/403/content/application~1json/examples/customHeaders"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/500/content/application~1json/examples/dbError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/500/content/application~1json/examples/dbError"]}}},{"code":"502","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/502/content/application~1json/examples/queryService"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/502/content/application~1json/examples/queryService"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bi-views/describebiviewcolumnsv2"}],"panels":[]}]},"httpPath":"/api/integration/v2/biviews/{tmpl_name}/describe-columns"},{"label":"Submit a BI View report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-views/submitbiviewreport","routeSlug":"/other-api/revenue-api-3.0/bi-views/submitbiviewreport","metadata":{"seo":{"title":"Submit a BI View report","description":"Submits a background job that writes the whole BI View for a date range to a report file. Returns the submission ID of the job."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"submitBiViewReport","name":"Submit a BI View report","isWebhook":false,"pointer":"/paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a BI View report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submits a background job that writes the whole BI View for a date range to a report file. Returns the submission ID of the job."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Produce a complete extract as one file instead of paging through the data. When the file is ready, download it with "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a signed URL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dates use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD-Mon-YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"01-Sep-2026"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (different from the paged operations)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Poll "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a report file by submission ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until the file appears, then call "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a signed URL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"in_view_name","in":"path","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BI View API name. Standard views: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_ACCT_TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_APPR_DTL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_BOOK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_CALENDAR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_MJE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_ORG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_PERIODS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_BILL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_HEAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LNS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LN_COST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_POB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_SCHD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_SCHD_DEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RI_ACCT_SUMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_LINE_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_EVENT_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_CT_MOD_DETAIL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LNS_VERSION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_POB_ACTIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_CT_MOD_DET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_HOLD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom views configured for your tenant are also accepted."},"children":[]}]}]}],"required":true,"example":"BI3_RC_SCHD"}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fromDate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD-Mon-YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"01-Sep-2026"},{"name":"toDate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD-Mon-YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"30-Sep-2026"}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/integration/v2/biviews/report/{in_view_name}","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"in_view_name","in":"path","required":true,"example":"BI3_RC_SCHD","schemaId":"schema_3"}],"query":[{"name":"fromDate","in":"query","required":true,"example":"01-Sep-2026","schemaId":"schema_3"},{"name":"toDate","in":"query","required":true,"example":"30-Sep-2026","schemaId":"schema_3"}],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","502"],"pointer":"/api/integration/v2/biviews/report/{in_view_name}","href":"bi-views/submitbiviewreport","openApiOperationId":"submitBiViewReport","summary":"Submit a BI View report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The job was accepted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BiViewReportSubmitResponse","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/200/content/application~1json/examples/accepted"]}},"schemaId":"components/schemas/BiViewReportSubmitResponse","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/200/content/application~1json/examples/accepted"]},{"code":"400","description":"A date is missing or invalid, the view name is unknown, or the job was rejected. Also returned when the database connection fails (retry with backoff).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_42","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/missingParam","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/rejected","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/dbConnect"]}},"schemaId":"schema_42","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/missingParam","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/rejected","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/dbConnect"]},{"code":"401","description":"The access token is missing, invalid or expired (gateway), or the OAuth client's user is not a Zuora Revenue user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/401/content/application~1json/examples/noRevenueUser"]}},"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/401/content/application~1json/examples/noRevenueUser"]},{"code":"403","description":"The request was rejected by the Integration service. Either the tenant is not enabled for this API, or the tenant requires custom request headers that were not sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/403/content/application~1json/examples/customHeaders"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/403/content/application~1json/examples/customHeaders"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":"Unexpected server or database error. Retry later; if it persists, contact Zuora Support.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/500/content/application~1json/examples/dbError"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/500/content/application~1json/examples/dbError"]},{"code":"502","description":"An internal query service did not respond correctly. Retry later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/502/content/application~1json/examples/queryService"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/502/content/application~1json/examples/queryService"]}],"pointer":"/paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BiViewReportSubmitResponse","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/200/content/application~1json/examples/accepted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BiViewReportSubmitResponse","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/200/content/application~1json/examples/accepted"]}}},{"code":"400","schemaId":"schema_42","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/missingParam","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/rejected","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/dbConnect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_42","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/missingParam","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/badDate","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/rejected","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/dbConnect"]}}},{"code":"401","schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/401/content/application~1json/examples/noRevenueUser"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/401/content/application~1json/examples/noRevenueUser"]}}},{"code":"403","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/403/content/application~1json/examples/customHeaders"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/403/content/application~1json/examples/customHeaders"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/500/content/application~1json/examples/dbError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/500/content/application~1json/examples/dbError"]}}},{"code":"502","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/502/content/application~1json/examples/queryService"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/502/content/application~1json/examples/queryService"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bi-views/submitbiviewreport"}],"panels":[]}]},"httpPath":"/api/integration/v2/biviews/report/{in_view_name}"},{"label":"Retrieve BI View data (v1)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-views/getbiviewdatav1","routeSlug":"/other-api/revenue-api-3.0/bi-views/getbiviewdatav1","metadata":{"seo":{"title":"Retrieve BI View data (v1)","description":"Returns BI View rows as CSV, one page per call, for a date range. Without a date range it returns the view's columns; with count=true it returns the row count; with format=csv and no dates it returns only the CSV header row. Use POST with a Fields body to select columns."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBiViewDataV1","name":"Retrieve BI View data (v1)","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve BI View data (v1)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns BI View rows as CSV, one page per call, for a date range. Without a date range it returns the view's columns; with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it returns the row count; with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format=csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and no dates it returns only the CSV header row. Use POST with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body to select columns."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Existing integrations built on v1. New integrations should use the v2 operations, which handle large volumes better."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required and must match the client of your user (usually "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-ddTHH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be later than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pages start at 1. Increase "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagenum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until the response is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagesize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (lowercase) accepts 1 to 10,000; other values fall back to 1,000."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are selected, the response headers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagenum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (next page) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (rows in this page) are added."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV rows are returned with content type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; read the body as CSV text."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tmpl_name","in":"path","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BI View API name. Standard views: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_ACCT_TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_APPR_DTL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_BOOK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_CALENDAR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_MJE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_ORG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_PERIODS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_BILL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_HEAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LNS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LN_COST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_POB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_SCHD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_SCHD_DEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RI_ACCT_SUMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_LINE_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_EVENT_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_CT_MOD_DETAIL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LNS_VERSION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_POB_ACTIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_CT_MOD_DET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_HOLD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom views configured for your tenant are also accepted."},"children":[]}]}]}],"required":true,"example":"BI3_RC_HEAD"}],"pointer":"/paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"clientId","in":"query","schemaId":"schema_5","description":"Zuora Revenue client ID of your user.","required":true,"example":1},{"name":"fromDate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the date range, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-ddTHH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-09-01T00:00:00"},{"name":"toDate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End of the date range, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-ddTHH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-09-30T23:59:59"},{"name":"pagenum","in":"query","schemaId":"schema_43","description":"Page to return, starting at 1.","example":1},{"name":"pagesize","in":"query","schemaId":"schema_34","description":"Rows per page, 1 to 10,000.","example":1000},{"name":"count","in":"query","schemaId":"schema_36","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), return the row count instead of rows."},"children":[]}]}]}],"example":false},{"name":"format","in":"query","schemaId":"schema_44","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and no dates, return only the CSV header row."},"children":[]}]}]}],"example":"csv"}],"pointer":"/paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v1/biviews/{tmpl_name}","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"tmpl_name","in":"path","required":true,"example":"BI3_RC_HEAD","schemaId":"schema_3"}],"query":[{"name":"clientId","in":"query","required":true,"example":1,"schemaId":"schema_5"},{"name":"fromDate","in":"query","required":false,"example":"2026-09-01T00:00:00","schemaId":"schema_3"},{"name":"toDate","in":"query","required":false,"example":"2026-09-30T23:59:59","schemaId":"schema_3"},{"name":"pagenum","in":"query","required":false,"example":1,"schemaId":"schema_43"},{"name":"pagesize","in":"query","required":false,"example":1000,"schemaId":"schema_34"},{"name":"count","in":"query","required":false,"example":false,"schemaId":"schema_36"},{"name":"format","in":"query","required":false,"example":"csv","schemaId":"schema_44"}],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","204","400","401","403","429","500","502"],"pointer":"/api/integration/v1/biviews/{tmpl_name}","href":"bi-views/getbiviewdatav1","openApiOperationId":"getBiViewDataV1","summary":"Retrieve BI View data (v1)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV rows ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or JSON with the row count ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or the column list (no dates; the columns are returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_3","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/200/content/text~1html/examples/rows"]},"application/json":{"schemaId":"schema_45","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/200/content/application~1json/examples/count","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/200/content/application~1json/examples/columns"]}},"schemaId":"schema_3","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/200/content/text~1html/examples/rows"]},{"code":"204","description":"No rows for the criteria, or past the last page. No body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The view name is unknown, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is missing or wrong, a date is invalid or out of order, the POST body is not JSON, a selected field does not exist, or the row count failed. Also returned when the database connection fails (retry with backoff)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badClient","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dateOrder","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dateFormat","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badBody","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badField","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/countFailed","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badClient","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dateOrder","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dateFormat","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badBody","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badField","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/countFailed","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect"]},{"code":"401","description":"The access token is missing, invalid or expired (gateway), or the OAuth client's user is not a Zuora Revenue user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser"]}},"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser"]},{"code":"403","description":"The request was rejected by the Integration service. Either the tenant is not enabled for this API, or the tenant requires custom request headers that were not sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":"Column information for the CSV header could not be read.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/500/content/application~1json/examples/meta"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/500/content/application~1json/examples/meta"]},{"code":"502","description":"An internal query service did not respond correctly. Retry later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService"]}],"pointer":"/paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_3","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/200/content/text~1html/examples/rows"],"mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_3","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/200/content/text~1html/examples/rows"]},"application/json":{"schemaId":"schema_45","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/200/content/application~1json/examples/count","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/200/content/application~1json/examples/columns"]}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badClient","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dateOrder","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dateFormat","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badBody","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badField","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/countFailed","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badClient","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dateOrder","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dateFormat","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badBody","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badField","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/countFailed","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect"]}}},{"code":"401","schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser"]}}},{"code":"403","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/500/content/application~1json/examples/meta"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/500/content/application~1json/examples/meta"]}}},{"code":"502","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bi-views/getbiviewdatav1"}],"panels":[]}]},"httpPath":"/api/integration/v1/biviews/{tmpl_name}"},{"label":"Get BI View data (v1) (POST)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-views/getbiviewdatav1post","routeSlug":"/other-api/revenue-api-3.0/bi-views/getbiviewdatav1post","metadata":{"seo":{"title":"Get BI View data (v1) (POST)","description":"Returns BI View rows as CSV, one page per call, for a date range. Without a date range it returns the view's columns; with count=true it returns the row count; with format=csv and no dates it returns only the CSV header row. Use POST with a Fields body to select columns."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBiViewDataV1Post","name":"Get BI View data (v1) (POST)","isWebhook":false,"pointer":"/paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get BI View data (v1) (POST)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns BI View rows as CSV, one page per call, for a date range. Without a date range it returns the view's columns; with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it returns the row count; with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"format=csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and no dates it returns only the CSV header row. Use POST with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" body to select columns."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Existing integrations built on v1. New integrations should use the v2 operations, which handle large volumes better."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required and must match the client of your user (usually "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-ddTHH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be later than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pages start at 1. Increase "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagenum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until the response is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagesize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (lowercase) accepts 1 to 10,000; other values fall back to 1,000."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are selected, the response headers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pagenum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (next page) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"record_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (rows in this page) are added."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV rows are returned with content type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/html"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; read the body as CSV text."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tmpl_name","in":"path","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BI View API name. Standard views: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_ACCT_TYPE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_APPR_DTL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_BOOK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_CALENDAR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_MJE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_ORG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_PERIODS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_BILL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_HEAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LNS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LN_COST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_POB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_SCHD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_SCHD_DEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RI_ACCT_SUMM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_LINE_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_EVENT_STAGE_HISTORY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_CT_MOD_DETAIL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_LNS_VERSION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_POB_ACTIONS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_CT_MOD_DET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BI3_RC_HOLD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom views configured for your tenant are also accepted."},"children":[]}]}]}],"required":true,"example":"BI3_RC_HEAD"}],"pointer":"/paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"clientId","in":"query","schemaId":"schema_5","description":"Zuora Revenue client ID of your user.","required":true,"example":1},{"name":"fromDate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the date range, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-ddTHH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-09-01T00:00:00"},{"name":"toDate","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End of the date range, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-ddTHH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-09-30T23:59:59"},{"name":"pagenum","in":"query","schemaId":"schema_43","description":"Page to return, starting at 1.","example":1},{"name":"pagesize","in":"query","schemaId":"schema_34","description":"Rows per page, 1 to 10,000.","example":1000},{"name":"count","in":"query","schemaId":"schema_36","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fromDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"toDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), return the row count instead of rows."},"children":[]}]}]}],"example":false},{"name":"format","in":"query","schemaId":"schema_44","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and no dates, return only the CSV header row."},"children":[]}]}]}],"example":"csv"}],"pointer":"/paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/fields"]}},"schemaId":"schema_40","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/fields"],"pointer":"/paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/requestBody","description":"POST only. Columns to return."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/integration/v1/biviews/{tmpl_name}","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"tmpl_name","in":"path","required":true,"example":"BI3_RC_HEAD","schemaId":"schema_3"}],"query":[{"name":"clientId","in":"query","required":true,"example":1,"schemaId":"schema_5"},{"name":"fromDate","in":"query","required":false,"example":"2026-09-01T00:00:00","schemaId":"schema_3"},{"name":"toDate","in":"query","required":false,"example":"2026-09-30T23:59:59","schemaId":"schema_3"},{"name":"pagenum","in":"query","required":false,"example":1,"schemaId":"schema_43"},{"name":"pagesize","in":"query","required":false,"example":1000,"schemaId":"schema_34"},{"name":"count","in":"query","required":false,"example":false,"schemaId":"schema_36"},{"name":"format","in":"query","required":false,"example":"csv","schemaId":"schema_44"}],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/fields"]}},"responseCodes":["200","204","400","401","403","429","500","502"],"pointer":"/api/integration/v1/biviews/{tmpl_name}","href":"bi-views/getbiviewdatav1post","openApiOperationId":"getBiViewDataV1Post","summary":"Get BI View data (v1) (POST)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"schemaId":"schema_40","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/fields"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/fields"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV rows ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or JSON with the row count ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or the column list (no dates; the columns are returned in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"mediaType":"text/html","mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_3","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/200/content/text~1html/examples/rows"]},"application/json":{"schemaId":"schema_45","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/200/content/application~1json/examples/count","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/200/content/application~1json/examples/columns"]}},"schemaId":"schema_3","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/200/content/text~1html/examples/rows"]},{"code":"204","description":"No rows for the criteria, or past the last page. No body."},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The view name is unknown, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is missing or wrong, a date is invalid or out of order, the POST body is not JSON, a selected field does not exist, or the row count failed. Also returned when the database connection fails (retry with backoff)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badClient","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dateOrder","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dateFormat","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badBody","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badField","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/countFailed","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dbConnect"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badClient","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dateOrder","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dateFormat","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badBody","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badField","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/countFailed","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dbConnect"]},{"code":"401","description":"The access token is missing, invalid or expired (gateway), or the OAuth client's user is not a Zuora Revenue user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/noRevenueUser"]}},"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/noRevenueUser"]},{"code":"403","description":"The request was rejected by the Integration service. Either the tenant is not enabled for this API, or the tenant requires custom request headers that were not sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/customHeaders"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/customHeaders"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":"Column information for the CSV header could not be read.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/500/content/application~1json/examples/meta"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/500/content/application~1json/examples/meta"]},{"code":"502","description":"An internal query service did not respond correctly. Retry later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/502/content/application~1json/examples/queryService"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/502/content/application~1json/examples/queryService"]}],"pointer":"/paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_3","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/200/content/text~1html/examples/rows"],"mediaTypes":["text/html","application/json"],"mediaTypeContent":{"text/html":{"schemaId":"schema_3","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/200/content/text~1html/examples/rows"]},"application/json":{"schemaId":"schema_45","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/200/content/application~1json/examples/count","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/200/content/application~1json/examples/columns"]}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badClient","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dateOrder","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dateFormat","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badBody","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badField","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/countFailed","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dbConnect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badView","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badClient","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dateOrder","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dateFormat","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badBody","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badField","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/countFailed","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dbConnect"]}}},{"code":"401","schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/noRevenueUser"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/noRevenueUser"]}}},{"code":"403","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/customHeaders"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/customHeaders"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/500/content/application~1json/examples/meta"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/500/content/application~1json/examples/meta"]}}},{"code":"502","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/502/content/application~1json/examples/queryService"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/502/content/application~1json/examples/queryService"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bi-views/getbiviewdatav1post"}],"panels":[]}]},"httpPath":"/api/integration/v1/biviews/{tmpl_name}"}],"content":{"contentType":"group","meta":{"name":"BI Views"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"BI Views","showPageActions":true},{"nodeType":"markdoc","content":"Extract BI View data (revenue contracts, lines, schedules, journal data and more) in pages, count rows, describe columns, or submit a BI View as a background report."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/integration/v2/biviews/{tmpl_name}","summary":"Retrieve BI View data (v2, paged)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bi-views/getbiviewdatav2","deprecated":false},{"title":"/api/integration/v2/biviews/{tmpl_name}","summary":"Get BI View data (v2, paged) (POST)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bi-views/getbiviewdatav2post","deprecated":false},{"title":"/api/integration/v2/biviews/count/{tmpl_name}","summary":"Count BI View rows","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bi-views/countbiviewrowsv2","deprecated":false},{"title":"/api/integration/v2/biviews/{tmpl_name}/describe-columns","summary":"List BI View columns","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bi-views/describebiviewcolumnsv2","deprecated":false},{"title":"/api/integration/v2/biviews/report/{in_view_name}","summary":"Submit a BI View report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bi-views/submitbiviewreport","deprecated":false},{"title":"/api/integration/v1/biviews/{tmpl_name}","summary":"Retrieve BI View data (v1)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bi-views/getbiviewdatav1","deprecated":false},{"title":"/api/integration/v1/biviews/{tmpl_name}","summary":"Get BI View data (v1) (POST)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bi-views/getbiviewdatav1post","deprecated":false}]}]}]}]}},{"type":"group","label":"BI View Tasks","link":"/other-api/revenue-api-3.0/bi-view-tasks","routeSlug":"/other-api/revenue-api-3.0/bi-view-tasks","items":[{"label":"List BI View tasks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-view-tasks/listbiviewtasks","routeSlug":"/other-api/revenue-api-3.0/bi-view-tasks/listbiviewtasks","metadata":{"seo":{"title":"List BI View tasks","description":"Returns the tenant's background BI View tasks grouped into active, completed, stale and draining."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBiViewTasks","name":"List BI View tasks","isWebhook":false,"pointer":"/paths/~1api~1integration~1v2~1biviews-status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List BI View tasks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the tenant's background BI View tasks grouped into active, completed, stale and draining."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" See which extractions are running before you start another one (each tenant has a query quota), and find stuck tasks to cancel."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A task is stale when it has reported no progress for 240 seconds (tenant-configurable)."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1api~1integration~1v2~1biviews-status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v2/biviews-status","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","204","400","401","403","429","500","502"],"pointer":"/api/integration/v2/biviews-status","href":"bi-view-tasks/listbiviewtasks","openApiOperationId":"listBiViewTasks","summary":"List BI View tasks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Tasks grouped by state.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BiViewTaskQueues","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/200/content/application~1json/examples/tasks"]}},"schemaId":"components/schemas/BiViewTaskQueues","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/200/content/application~1json/examples/tasks"]},{"code":"204","description":"The tenant has no tracked tasks. No body."},{"code":"400","description":"The database connection failed. Retry with backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/400/content/application~1json/examples/dbConnect"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/400/content/application~1json/examples/dbConnect"]},{"code":"401","description":"The access token is missing, invalid or expired (gateway), or the OAuth client's user is not a Zuora Revenue user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews-status/get/responses/401/content/application~1json/examples/noRevenueUser"]}},"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews-status/get/responses/401/content/application~1json/examples/noRevenueUser"]},{"code":"403","description":"The request was rejected by the Integration service. Either the tenant is not enabled for this API, or the tenant requires custom request headers that were not sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews-status/get/responses/403/content/application~1json/examples/customHeaders"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews-status/get/responses/403/content/application~1json/examples/customHeaders"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":"Unexpected server or database error. Retry later; if it persists, contact Zuora Support.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/500/content/application~1json/examples/dbError"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/500/content/application~1json/examples/dbError"]},{"code":"502","description":"An internal query service did not respond correctly. Retry later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/502/content/application~1json/examples/queryService"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/502/content/application~1json/examples/queryService"]}],"pointer":"/paths/~1api~1integration~1v2~1biviews-status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BiViewTaskQueues","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/200/content/application~1json/examples/tasks"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BiViewTaskQueues","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/200/content/application~1json/examples/tasks"]}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/400/content/application~1json/examples/dbConnect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/400/content/application~1json/examples/dbConnect"]}}},{"code":"401","schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews-status/get/responses/401/content/application~1json/examples/noRevenueUser"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews-status/get/responses/401/content/application~1json/examples/noRevenueUser"]}}},{"code":"403","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews-status/get/responses/403/content/application~1json/examples/customHeaders"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews-status/get/responses/403/content/application~1json/examples/customHeaders"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/500/content/application~1json/examples/dbError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/500/content/application~1json/examples/dbError"]}}},{"code":"502","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/502/content/application~1json/examples/queryService"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status/get/responses/502/content/application~1json/examples/queryService"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bi-view-tasks/listbiviewtasks"}],"panels":[]}]},"httpPath":"/api/integration/v2/biviews-status"},{"label":"Retrieve a BI View task","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-view-tasks/getbiviewtask","routeSlug":"/other-api/revenue-api-3.0/bi-view-tasks/getbiviewtask","metadata":{"seo":{"title":"Retrieve a BI View task","description":"Returns the state of one background BI View task."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBiViewTask","name":"Retrieve a BI View task","isWebhook":false,"pointer":"/paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a BI View task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the state of one background BI View task."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Track the progress of an extraction you started (the task ID is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuation-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task identifier (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuation-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value)."},"children":[]}]}]}],"required":true,"example":"3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4"}],"pointer":"/paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/integration/v2/biviews-status/{task_id}","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"example":"3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4","schemaId":"schema_3"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","204","400","401","403","429","500","502"],"pointer":"/api/integration/v2/biviews-status/{task_id}","href":"bi-view-tasks/getbiviewtask","openApiOperationId":"getBiViewTask","summary":"Retrieve a BI View task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The task.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BiViewTask","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/200/content/application~1json/examples/task"]}},"schemaId":"components/schemas/BiViewTask","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/200/content/application~1json/examples/task"]},{"code":"204","description":"The task is unknown or has expired. No body."},{"code":"400","description":"The database connection failed. Retry with backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/400/content/application~1json/examples/dbConnect"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/400/content/application~1json/examples/dbConnect"]},{"code":"401","description":"The access token is missing, invalid or expired (gateway), or the OAuth client's user is not a Zuora Revenue user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/401/content/application~1json/examples/noRevenueUser"]}},"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/401/content/application~1json/examples/noRevenueUser"]},{"code":"403","description":"The request was rejected by the Integration service. Either the tenant is not enabled for this API, or the tenant requires custom request headers that were not sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/403/content/application~1json/examples/customHeaders"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/403/content/application~1json/examples/customHeaders"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":"Unexpected server or database error. Retry later; if it persists, contact Zuora Support.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/500/content/application~1json/examples/dbError"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/500/content/application~1json/examples/dbError"]},{"code":"502","description":"An internal query service did not respond correctly. Retry later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/502/content/application~1json/examples/queryService"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/502/content/application~1json/examples/queryService"]}],"pointer":"/paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BiViewTask","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/200/content/application~1json/examples/task"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BiViewTask","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/200/content/application~1json/examples/task"]}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/400/content/application~1json/examples/dbConnect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/400/content/application~1json/examples/dbConnect"]}}},{"code":"401","schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/401/content/application~1json/examples/noRevenueUser"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/401/content/application~1json/examples/noRevenueUser"]}}},{"code":"403","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/403/content/application~1json/examples/customHeaders"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/403/content/application~1json/examples/customHeaders"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/500/content/application~1json/examples/dbError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/500/content/application~1json/examples/dbError"]}}},{"code":"502","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/502/content/application~1json/examples/queryService"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/502/content/application~1json/examples/queryService"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bi-view-tasks/getbiviewtask"}],"panels":[]}]},"httpPath":"/api/integration/v2/biviews-status/{task_id}"},{"label":"Cancel a BI View task","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/bi-view-tasks/cancelbiviewtask","routeSlug":"/other-api/revenue-api-3.0/bi-view-tasks/cancelbiviewtask","metadata":{"seo":{"title":"Cancel a BI View task","description":"Stops a background BI View task and marks it CANCELLED. Pages already written can no longer be relied on."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelBiViewTask","name":"Cancel a BI View task","isWebhook":false,"pointer":"/paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a BI View task","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stops a background BI View task and marks it "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Pages already written can no longer be relied on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Free your tenant's query quota when an extraction was started by mistake or is stuck."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The stop request is sent even when the task details have expired; in that case the response is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"task_id","in":"path","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task identifier (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuation-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value)."},"children":[]}]}]}],"required":true,"example":"3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4"}],"pointer":"/paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Track-Id","in":"header","schemaId":"schema_3","description":"Optional correlation identifier (up to 64 characters) that you choose. The Zuora One gateway records it; quote it to Zuora Support when you report a problem.","example":"close-run-2026-09-001"}],"pointer":"/paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/integration/v2/biviews-status/{task_id}","servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"parameters":{"path":[{"name":"task_id","in":"path","required":true,"example":"3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4","schemaId":"schema_3"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Track-Id","in":"header","required":false,"example":"close-run-2026-09-001","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","204","400","401","403","429","500","502"],"pointer":"/api/integration/v2/biviews-status/{task_id}","href":"bi-view-tasks/cancelbiviewtask","openApiOperationId":"cancelBiViewTask","summary":"Cancel a BI View task"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com","description":"Zuora One production. Revenue Reporting paths start with /revenue/services/v1; Integration paths start with /api/integration/v1 or /api/integration/v2."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The task was cancelled. Returns its final state.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BiViewTask","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/200/content/application~1json/examples/cancelled"]}},"schemaId":"components/schemas/BiViewTask","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/200/content/application~1json/examples/cancelled"]},{"code":"204","description":"The task is unknown or has expired. No body."},{"code":"400","description":"The database connection failed. Retry with backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/400/content/application~1json/examples/dbConnect"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/400/content/application~1json/examples/dbConnect"]},{"code":"401","description":"The access token is missing, invalid or expired (gateway), or the OAuth client's user is not a Zuora Revenue user.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/401/content/application~1json/examples/noRevenueUser"]}},"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/401/content/application~1json/examples/noRevenueUser"]},{"code":"403","description":"The request was rejected by the Integration service. Either the tenant is not enabled for this API, or the tenant requires custom request headers that were not sent.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/403/content/application~1json/examples/customHeaders"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/403/content/application~1json/examples/customHeaders"]},{"code":"429","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Too many requests. Wait for the time in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header, then retry with backoff."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/429/content/application~1json/examples/rateLimited"]}},"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/429/content/application~1json/examples/rateLimited"],"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"string"}}},"headerSchemaId":"schema_27"},{"code":"500","description":"Unexpected server or database error. Retry later; if it persists, contact Zuora Support.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/500/content/application~1json/examples/dbError"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/500/content/application~1json/examples/dbError"]},{"code":"502","description":"An internal query service did not respond correctly. Retry later.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/502/content/application~1json/examples/queryService"]}},"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/502/content/application~1json/examples/queryService"]}],"pointer":"/paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BiViewTask","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/200/content/application~1json/examples/cancelled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BiViewTask","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/200/content/application~1json/examples/cancelled"]}}},{"code":"204"},{"code":"400","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/400/content/application~1json/examples/dbConnect"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/400/content/application~1json/examples/dbConnect"]}}},{"code":"401","schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/401/content/application~1json/examples/noRevenueUser"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/401/content/application~1json/examples/unauthorized","paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/401/content/application~1json/examples/noRevenueUser"]}}},{"code":"403","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/403/content/application~1json/examples/customHeaders"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/403/content/application~1json/examples/restricted","paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/403/content/application~1json/examples/customHeaders"]}}},{"code":"429","schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/429/content/application~1json/examples/rateLimited"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/429/content/application~1json/examples/rateLimited"]}}},{"code":"500","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/500/content/application~1json/examples/dbError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/500/content/application~1json/examples/dbError"]}}},{"code":"502","schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/502/content/application~1json/examples/queryService"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RiaError","exampleIds":["paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/502/content/application~1json/examples/queryService"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bi-view-tasks/cancelbiviewtask"}],"panels":[]}]},"httpPath":"/api/integration/v2/biviews-status/{task_id}"}],"content":{"contentType":"group","meta":{"name":"BI View Tasks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"BI View Tasks","showPageActions":true},{"nodeType":"markdoc","content":"Monitor and cancel the background tasks that prepare BI View pages."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/integration/v2/biviews-status","summary":"List BI View tasks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bi-view-tasks/listbiviewtasks","deprecated":false},{"title":"/api/integration/v2/biviews-status/{task_id}","summary":"Retrieve a BI View task","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bi-view-tasks/getbiviewtask","deprecated":false},{"title":"/api/integration/v2/biviews-status/{task_id}","summary":"Cancel a BI View task","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/bi-view-tasks/cancelbiviewtask","deprecated":false}]}]}]}]}},{"type":"separator","label":"Revenue Manual Journals","content":null},{"type":"group","label":"Journal Entries","link":"/other-api/revenue-api-3.0/journal-entries","routeSlug":"/other-api/revenue-api-3.0/journal-entries","items":[{"label":"Create a journal entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/createjournalentry","routeSlug":"/other-api/revenue-api-3.0/journal-entries/createjournalentry","metadata":{"seo":{"title":"Create a journal entry","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createJournalEntry","name":"Create a journal entry","isWebhook":false,"pointer":"/paths/~1journal-entries/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a journal entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a manual journal entry (header plus at least one line) in a single atomic call. Choose the request format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeHeader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - send the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file part. Use a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"combined"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" CSV (header section, blank line, lines section) or a "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lines-only"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" CSV together with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeHeader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" JSON part. Supplying the header in both places is rejected."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All mandatory fields are validated before anything is saved; if any check fails, nothing is created and every problem is reported in one message. The new entry starts in status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"New"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and is validated asynchronously - poll GET /journal-entries/{jeId}/validation-status, then submit it for approval."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need to record a new manual adjustment (reclass, accrual, correction) in Zuora Revenue from an external system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when your integration builds entries programmatically; use "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when users prepare entries in a spreadsheet or when migrating many lines at once."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Do not use it to change an existing entry - use PATCH /journal-entries/{jeId}; to repeat an existing entry use POST /journal-entries/{jeId}/copy."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional client-generated unique key (for example a UUID). Accepted for forward compatibility; "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not currently enforced"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the service does not de-duplicate retries, so do not rely on it to prevent duplicate entries."},"children":[]}]}]}],"example":"6f1c2c3e-0b7a-4d1e-9a51-1f1e2a3b4c5d"}],"pointer":"/paths/~1journal-entries/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateJournalEntryRequest","exampleIds":["paths/~1journal-entries/post/requestBody/content/application~1json/examples/balancedReclass"]},"multipart/form-data":{"schemaId":"components/schemas/CreateJournalEntryMultipartRequest","exampleIds":["paths/~1journal-entries/post/requestBody/content/multipart~1form-data/examples/combinedCsv"]}},"schemaId":"components/schemas/CreateJournalEntryRequest","exampleIds":["paths/~1journal-entries/post/requestBody/content/application~1json/examples/balancedReclass"],"pointer":"/paths/~1journal-entries/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"example":"6f1c2c3e-0b7a-4d1e-9a51-1f1e2a3b4c5d","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateJournalEntryRequest","exampleIds":["paths/~1journal-entries/post/requestBody/content/application~1json/examples/balancedReclass"]},"multipart/form-data":{"schemaId":"components/schemas/CreateJournalEntryMultipartRequest","exampleIds":["paths/~1journal-entries/post/requestBody/content/multipart~1form-data/examples/combinedCsv"]}},"responseCodes":["201","400","401","403","429","500","502"],"pointer":"/journal-entries","href":"journal-entries/createjournalentry","openApiOperationId":"createJournalEntry","summary":"Create a journal entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/CreateJournalEntryRequest","exampleIds":["paths/~1journal-entries/post/requestBody/content/application~1json/examples/balancedReclass"],"mediaTypes":["application/json","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateJournalEntryRequest","exampleIds":["paths/~1journal-entries/post/requestBody/content/application~1json/examples/balancedReclass"]},"multipart/form-data":{"schemaId":"components/schemas/CreateJournalEntryMultipartRequest","exampleIds":["paths/~1journal-entries/post/requestBody/content/multipart~1form-data/examples/combinedCsv"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Journal entry created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JournalEntryResponse","exampleIds":["paths/~1journal-entries/post/responses/201/content/application~1json/examples/journalEntryCreated"]}},"schemaId":"components/schemas/JournalEntryResponse","exampleIds":["paths/~1journal-entries/post/responses/201/content/application~1json/examples/journalEntryCreated"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"400","description":"Missing required fields; Invalid values; Unknown Set of Books; Invalid CSV; Header supplied twice","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/post/responses/400/content/application~1json/examples/missingRequiredFields","paths/~1journal-entries/post/responses/400/content/application~1json/examples/invalidValues","paths/~1journal-entries/post/responses/400/content/application~1json/examples/unknownSetOfBooks","paths/~1journal-entries/post/responses/400/content/application~1json/examples/invalidCsv","paths/~1journal-entries/post/responses/400/content/application~1json/examples/headerSuppliedTwice"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/post/responses/400/content/application~1json/examples/missingRequiredFields","paths/~1journal-entries/post/responses/400/content/application~1json/examples/invalidValues","paths/~1journal-entries/post/responses/400/content/application~1json/examples/unknownSetOfBooks","paths/~1journal-entries/post/responses/400/content/application~1json/examples/invalidCsv","paths/~1journal-entries/post/responses/400/content/application~1json/examples/headerSuppliedTwice"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Entry rejected by journal entry processing; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/post/responses/502/content/application~1json/examples/entryRejectedByJournalEntryProcessing","paths/~1journal-entries/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/post/responses/502/content/application~1json/examples/entryRejectedByJournalEntryProcessing","paths/~1journal-entries/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/JournalEntryResponse","exampleIds":["paths/~1journal-entries/post/responses/201/content/application~1json/examples/journalEntryCreated"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JournalEntryResponse","exampleIds":["paths/~1journal-entries/post/responses/201/content/application~1json/examples/journalEntryCreated"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/post/responses/400/content/application~1json/examples/missingRequiredFields","paths/~1journal-entries/post/responses/400/content/application~1json/examples/invalidValues","paths/~1journal-entries/post/responses/400/content/application~1json/examples/unknownSetOfBooks","paths/~1journal-entries/post/responses/400/content/application~1json/examples/invalidCsv","paths/~1journal-entries/post/responses/400/content/application~1json/examples/headerSuppliedTwice"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/post/responses/400/content/application~1json/examples/missingRequiredFields","paths/~1journal-entries/post/responses/400/content/application~1json/examples/invalidValues","paths/~1journal-entries/post/responses/400/content/application~1json/examples/unknownSetOfBooks","paths/~1journal-entries/post/responses/400/content/application~1json/examples/invalidCsv","paths/~1journal-entries/post/responses/400/content/application~1json/examples/headerSuppliedTwice"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/post/responses/502/content/application~1json/examples/entryRejectedByJournalEntryProcessing","paths/~1journal-entries/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/post/responses/502/content/application~1json/examples/entryRejectedByJournalEntryProcessing","paths/~1journal-entries/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-entries/createjournalentry"}],"panels":[]}]},"httpPath":"/journal-entries"},{"label":"List journal entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/listjournalentries","routeSlug":"/other-api/revenue-api-3.0/journal-entries/listjournalentries","metadata":{"seo":{"title":"List journal entries","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listJournalEntries","name":"List journal entries","isWebhook":false,"pointer":"/paths/~1journal-entries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List journal entries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a page of journal entries visible to the caller. Supports filtering, sorting, field selection and page-based pagination."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Build a work list or dashboard of entries, for example all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"New"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entries for this period or everything waiting for approval."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reconcile during close: find entries by status, category, creator or date and page through the results."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use POST /journal-entries/query instead when the filter is long or needs several values in an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversalPeriodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in list results contain the period "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEP-2026"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and filters on them compare against the name: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter=periodId.EQ:SEP-2026"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", date-time properties are returned as epoch milliseconds instead of formatted strings."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names must match the response property names, so use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exRateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multi-value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" lists: when the request has only one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter, commas inside its value are treated as list separators. To filter on several values reliably, add a second "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter or use POST /journal-entries/query."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter clause in the form "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field.OPERATOR:value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Repeat the parameter to combine clauses with AND. Operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (equals), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not equals), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (comparisons for numbers and dates), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (starts with) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (any of a list: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field.IN:[v1,v2]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Values are not quoted. Allowed fields for journal entries: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approverName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"categoryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"functionalCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hashTotal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversalPeriodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversalStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sobName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Unknown fields return 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":["status.EQ:New"]},{"name":"sort","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort clause "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only the first sort clause is applied. Uses the same field names as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":["createdDate.DESC"]},{"name":"fields","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of properties to return for each record (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is always returned). Names must match the response property names exactly. When supplied, each record contains only these properties. Unknown names return 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":["name","status"]},{"name":"expand","in":"query","schemaId":"schema_47","description":"Reserved for future use; currently ignored."},{"name":"pageSize","in":"query","schemaId":"schema_48","description":"Number of records per page. Defaults to 20. Values above 40 are reduced to 40.","example":20},{"name":"cursor","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page to return. Use the 1-based page number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", ...). Defaults to the first page. A non-numeric or non-positive value returns 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2"}],"pointer":"/paths/~1journal-entries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":false,"example":["status.EQ:New"],"schemaId":"schema_47","style":"form","explode":true},{"name":"sort","in":"query","required":false,"example":["createdDate.DESC"],"schemaId":"schema_47","style":"form","explode":true},{"name":"fields","in":"query","required":false,"example":["name","status"],"schemaId":"schema_47","style":"form","explode":false},{"name":"expand","in":"query","required":false,"schemaId":"schema_47","style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"example":20,"schemaId":"schema_48"},{"name":"cursor","in":"query","required":false,"example":"2","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","502"],"pointer":"/journal-entries","href":"journal-entries/listjournalentries","openApiOperationId":"listJournalEntries","summary":"List journal entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Page of journal entries","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JournalEntryListPage","exampleIds":["paths/~1journal-entries/get/responses/200/content/application~1json/examples/pageOfJournalEntries","paths/~1journal-entries/get/responses/200/content/application~1json/examples/projected"]}},"schemaId":"components/schemas/JournalEntryListPage","exampleIds":["paths/~1journal-entries/get/responses/200/content/application~1json/examples/pageOfJournalEntries","paths/~1journal-entries/get/responses/200/content/application~1json/examples/projected"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"400","description":"Unknown filter field; Unsupported operator; Invalid cursor","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/get/responses/400/content/application~1json/examples/unknownFilterField","paths/~1journal-entries/get/responses/400/content/application~1json/examples/unsupportedOperator","paths/~1journal-entries/get/responses/400/content/application~1json/examples/invalidCursor"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/get/responses/400/content/application~1json/examples/unknownFilterField","paths/~1journal-entries/get/responses/400/content/application~1json/examples/unsupportedOperator","paths/~1journal-entries/get/responses/400/content/application~1json/examples/invalidCursor"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JournalEntryListPage","exampleIds":["paths/~1journal-entries/get/responses/200/content/application~1json/examples/pageOfJournalEntries","paths/~1journal-entries/get/responses/200/content/application~1json/examples/projected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JournalEntryListPage","exampleIds":["paths/~1journal-entries/get/responses/200/content/application~1json/examples/pageOfJournalEntries","paths/~1journal-entries/get/responses/200/content/application~1json/examples/projected"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/get/responses/400/content/application~1json/examples/unknownFilterField","paths/~1journal-entries/get/responses/400/content/application~1json/examples/unsupportedOperator","paths/~1journal-entries/get/responses/400/content/application~1json/examples/invalidCursor"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/get/responses/400/content/application~1json/examples/unknownFilterField","paths/~1journal-entries/get/responses/400/content/application~1json/examples/unsupportedOperator","paths/~1journal-entries/get/responses/400/content/application~1json/examples/invalidCursor"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-entries/listjournalentries"}],"panels":[]}]},"httpPath":"/journal-entries"},{"label":"Search journal entries (filter in body)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/queryjournalentries","routeSlug":"/other-api/revenue-api-3.0/journal-entries/queryjournalentries","metadata":{"seo":{"title":"Search journal entries (filter in body)","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryJournalEntries","name":"Search journal entries (filter in body)","isWebhook":false,"pointer":"/paths/~1journal-entries~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Search journal entries (filter in body)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same result as GET /journal-entries, but the filter, sort and page criteria are sent in the request body. Use it for long filters that would exceed URL length limits or for multi-value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your filter is too long for a URL, or you need multi-value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You prefer to send search criteria as JSON (for example from a reporting tool) rather than as query parameters."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body filter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values are passed through as-is and must be one of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversalStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"categoryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exRateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversalPeriodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hashTotal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sobName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"functionalCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approverName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must contain at least one element for every operator (including "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IS NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IS NOT NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversalPeriodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" compare against the period "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEP-2026"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" defaults to 1 and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to 20 when omitted; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" above 40 is reduced to 40."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for text comparisons; other operators compare values as-is and are intended for numeric and date fields."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of properties to return for each record ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always returned)."},"children":[]}]}]}],"example":["name","status"]}],"pointer":"/paths/~1journal-entries~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1query/post/requestBody/content/application~1json/examples/openEntries"]}},"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1query/post/requestBody/content/application~1json/examples/openEntries"],"pointer":"/paths/~1journal-entries~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries/query","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[{"name":"fields","in":"query","required":false,"example":["name","status"],"schemaId":"schema_47","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1query/post/requestBody/content/application~1json/examples/openEntries"]}},"responseCodes":["200","400","401","403","429","500","502"],"pointer":"/journal-entries/query","href":"journal-entries/queryjournalentries","openApiOperationId":"queryJournalEntries","summary":"Search journal entries (filter in body)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1query/post/requestBody/content/application~1json/examples/openEntries"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1query/post/requestBody/content/application~1json/examples/openEntries"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Page of journal entries","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JournalEntryListPage","exampleIds":["paths/~1journal-entries~1query/post/responses/200/content/application~1json/examples/pageOfJournalEntries"]}},"schemaId":"components/schemas/JournalEntryListPage","exampleIds":["paths/~1journal-entries~1query/post/responses/200/content/application~1json/examples/pageOfJournalEntries"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"400","description":"Unknown projection field","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1query/post/responses/400/content/application~1json/examples/unknownProjectionField"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1query/post/responses/400/content/application~1json/examples/unknownProjectionField"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1query/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1query/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1query/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1query/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1query/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1query/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1query/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1query/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1query/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1query/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Invalid filter field or operator; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1query/post/responses/502/content/application~1json/examples/invalidFilterFieldOrOperator","paths/~1journal-entries~1query/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1query/post/responses/502/content/application~1json/examples/invalidFilterFieldOrOperator","paths/~1journal-entries~1query/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1query/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JournalEntryListPage","exampleIds":["paths/~1journal-entries~1query/post/responses/200/content/application~1json/examples/pageOfJournalEntries"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JournalEntryListPage","exampleIds":["paths/~1journal-entries~1query/post/responses/200/content/application~1json/examples/pageOfJournalEntries"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1query/post/responses/400/content/application~1json/examples/unknownProjectionField"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1query/post/responses/400/content/application~1json/examples/unknownProjectionField"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1query/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1query/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1query/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1query/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1query/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1query/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1query/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1query/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1query/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1query/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1query/post/responses/502/content/application~1json/examples/invalidFilterFieldOrOperator","paths/~1journal-entries~1query/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1query/post/responses/502/content/application~1json/examples/invalidFilterFieldOrOperator","paths/~1journal-entries~1query/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-entries/queryjournalentries"}],"panels":[]}]},"httpPath":"/journal-entries/query"},{"label":"Retrieve a journal entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/getjournalentry","routeSlug":"/other-api/revenue-api-3.0/journal-entries/getjournalentry","metadata":{"seo":{"title":"Retrieve a journal entry","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJournalEntry","name":"Retrieve a journal entry","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a journal entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the full header of one journal entry, including status, waterfall status, error count and validation messages. Use GET /journal-entries/{jeId}/lines to read its lines."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You know the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and need the entry's current status, waterfall status, error count or validation messages."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After create, update or a workflow action, to confirm the resulting state."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you only need a few properties (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while polling)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", date-time properties (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are returned as epoch milliseconds."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of header properties to return. When supplied, the response is a flat object containing only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the requested header properties (no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeHeader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" wrapper)."},"children":[]}]}]}],"example":["name","status","waterfallStatus"]}],"pointer":"/paths/~1journal-entries~1{jeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/{jeId}","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[{"name":"fields","in":"query","required":false,"example":["name","status","waterfallStatus"],"schemaId":"schema_47","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}","href":"journal-entries/getjournalentry","openApiOperationId":"getJournalEntry","summary":"Retrieve a journal entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Journal entry","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/200/content/application~1json/examples/journalEntry","paths/~1journal-entries~1{jeId}/get/responses/200/content/application~1json/examples/projected"]}},"schemaId":"schema_49","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/200/content/application~1json/examples/journalEntry","paths/~1journal-entries~1{jeId}/get/responses/200/content/application~1json/examples/projected"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"400","description":"Unknown projection field","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/400/content/application~1json/examples/unknownProjectionField"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/400/content/application~1json/examples/unknownProjectionField"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Journal entry not found; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/500/content/application~1json/examples/journalEntryNotFound","paths/~1journal-entries~1{jeId}/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/500/content/application~1json/examples/journalEntryNotFound","paths/~1journal-entries~1{jeId}/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_49","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/200/content/application~1json/examples/journalEntry","paths/~1journal-entries~1{jeId}/get/responses/200/content/application~1json/examples/projected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/200/content/application~1json/examples/journalEntry","paths/~1journal-entries~1{jeId}/get/responses/200/content/application~1json/examples/projected"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/400/content/application~1json/examples/unknownProjectionField"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/400/content/application~1json/examples/unknownProjectionField"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/500/content/application~1json/examples/journalEntryNotFound","paths/~1journal-entries~1{jeId}/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/500/content/application~1json/examples/journalEntryNotFound","paths/~1journal-entries~1{jeId}/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-entries/getjournalentry"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}"},{"label":"Update a journal entry","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/updatejournalentry","routeSlug":"/other-api/revenue-api-3.0/journal-entries/updatejournalentry","metadata":{"seo":{"title":"Update a journal entry","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateJournalEntry","name":"Update a journal entry","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a journal entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a journal entry that is still editable (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"New"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Validated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Two request formats:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - partial header update. Send only the fields to change; lines are not touched."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV full-file update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") - the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file is the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" new set of lines. Rows whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column matches an existing line are updated, other rows are inserted, and existing lines missing from the file are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"deleted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Header changes may be sent in an optional CSV header section or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeHeader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" JSON part (not both). The file must contain at least one line."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After an update the entry is re-validated and the preview waterfall is regenerated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correct an entry that failed validation or was rejected, before (re)submitting it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to change header values only (name, period, category, description...)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV full-file update"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to replace the entry's lines in one atomic operation (edit, add and remove lines together)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not possible once the entry is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - recall it first, or reverse an approved entry."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Full-file CSV update: a row whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is blank "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or does not match an existing line of this entry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is inserted as a new line, and every existing line not matched is deleted. The lines export (POST /{jeId}/lines/export) does "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" include an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column - add an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column with the line IDs from GET /journal-entries/{jeId}/lines before re-uploading, otherwise all lines are replaced."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference columns must be titled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reference1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ... "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reference15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on upload; tenant-specific labels used in the template or export (for example "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ticket Number"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are not recognized and their values are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A JSON header update is checked by journal entry processing, not by the up-front field validation used on create."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateJournalEntryRequest","exampleIds":["paths/~1journal-entries~1{jeId}/patch/requestBody/content/application~1json/examples/renameAndMove"]},"multipart/form-data":{"schemaId":"components/schemas/UpdateJournalEntryMultipartRequest","exampleIds":["paths/~1journal-entries~1{jeId}/patch/requestBody/content/multipart~1form-data/examples/fullFile"]}},"schemaId":"components/schemas/UpdateJournalEntryRequest","exampleIds":["paths/~1journal-entries~1{jeId}/patch/requestBody/content/application~1json/examples/renameAndMove"],"pointer":"/paths/~1journal-entries~1{jeId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/journal-entries/{jeId}","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateJournalEntryRequest","exampleIds":["paths/~1journal-entries~1{jeId}/patch/requestBody/content/application~1json/examples/renameAndMove"]},"multipart/form-data":{"schemaId":"components/schemas/UpdateJournalEntryMultipartRequest","exampleIds":["paths/~1journal-entries~1{jeId}/patch/requestBody/content/multipart~1form-data/examples/fullFile"]}},"responseCodes":["200","400","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}","href":"journal-entries/updatejournalentry","openApiOperationId":"updateJournalEntry","summary":"Update a journal entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/UpdateJournalEntryRequest","exampleIds":["paths/~1journal-entries~1{jeId}/patch/requestBody/content/application~1json/examples/renameAndMove"],"mediaTypes":["application/json","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateJournalEntryRequest","exampleIds":["paths/~1journal-entries~1{jeId}/patch/requestBody/content/application~1json/examples/renameAndMove"]},"multipart/form-data":{"schemaId":"components/schemas/UpdateJournalEntryMultipartRequest","exampleIds":["paths/~1journal-entries~1{jeId}/patch/requestBody/content/multipart~1form-data/examples/fullFile"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Journal entry updated","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JournalEntryUpdateResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/200/content/application~1json/examples/journalEntryUpdated"]}},"schemaId":"components/schemas/JournalEntryUpdateResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/200/content/application~1json/examples/journalEntryUpdated"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"400","description":"Invalid CSV or line values; Unknown Set of Books","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/400/content/application~1json/examples/invalidCsvOrLineValues","paths/~1journal-entries~1{jeId}/patch/responses/400/content/application~1json/examples/unknownSetOfBooks"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/400/content/application~1json/examples/invalidCsvOrLineValues","paths/~1journal-entries~1{jeId}/patch/responses/400/content/application~1json/examples/unknownSetOfBooks"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}/patch/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}/patch/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Entry cannot be edited; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/502/content/application~1json/examples/entryCannotBeEdited","paths/~1journal-entries~1{jeId}/patch/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/502/content/application~1json/examples/entryCannotBeEdited","paths/~1journal-entries~1{jeId}/patch/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JournalEntryUpdateResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/200/content/application~1json/examples/journalEntryUpdated"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JournalEntryUpdateResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/200/content/application~1json/examples/journalEntryUpdated"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/400/content/application~1json/examples/invalidCsvOrLineValues","paths/~1journal-entries~1{jeId}/patch/responses/400/content/application~1json/examples/unknownSetOfBooks"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/400/content/application~1json/examples/invalidCsvOrLineValues","paths/~1journal-entries~1{jeId}/patch/responses/400/content/application~1json/examples/unknownSetOfBooks"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}/patch/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}/patch/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/502/content/application~1json/examples/entryCannotBeEdited","paths/~1journal-entries~1{jeId}/patch/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/patch/responses/502/content/application~1json/examples/entryCannotBeEdited","paths/~1journal-entries~1{jeId}/patch/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-entries/updatejournalentry"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}"},{"label":"Delete a journal entry","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/deletejournalentry","routeSlug":"/other-api/revenue-api-3.0/journal-entries/deletejournalentry","metadata":{"seo":{"title":"Delete a journal entry","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteJournalEntry","name":"Delete a journal entry","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a journal entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permanently deletes a journal entry together with its lines and preview schedules. Only entries that have not been approved can be deleted, and only by a caller whose role allows it. To delete several entries at once use POST /journal-entries/bulk-delete."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Discard a single entry that was created by mistake or is no longer needed, before it is approved."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use POST /journal-entries/bulk-delete to remove several entries in one call."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/journal-entries/{jeId}","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}","href":"journal-entries/deletejournalentry","openApiOperationId":"deleteJournalEntry","summary":"Delete a journal entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Journal entry deleted (no response body)","headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Delete not allowed; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/502/content/application~1json/examples/deleteNotAllowed","paths/~1journal-entries~1{jeId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/502/content/application~1json/examples/deleteNotAllowed","paths/~1journal-entries~1{jeId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/502/content/application~1json/examples/deleteNotAllowed","paths/~1journal-entries~1{jeId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}/delete/responses/502/content/application~1json/examples/deleteNotAllowed","paths/~1journal-entries~1{jeId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-entries/deletejournalentry"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}"},{"label":"Copy a journal entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/copyjournalentry","routeSlug":"/other-api/revenue-api-3.0/journal-entries/copyjournalentry","metadata":{"seo":{"title":"Copy a journal entry","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"copyJournalEntry","name":"Copy a journal entry","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1copy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Copy a journal entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new journal entry by copying the header and all lines of an existing one - useful for recurring entries. By default the copy is named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Copy of <name>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and posted to the current open period; override either with the optional body. The copy starts in status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"New"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring adjustments: copy last month's entry into the new period instead of rebuilding it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start a corrected version of an approved entry while keeping the original for audit."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supplied, the copy is created first and then renamed/moved. If the second step fails the call returns an error but the copy already exists (named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Copy of <name>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); look it up with GET /journal-entries/search/{jeName} before retrying."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}~1copy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CopyJournalEntryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/requestBody/content/application~1json/examples/nextMonth"]}},"schemaId":"components/schemas/CopyJournalEntryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/requestBody/content/application~1json/examples/nextMonth"],"pointer":"/paths/~1journal-entries~1{jeId}~1copy/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries/{jeId}/copy","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CopyJournalEntryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/requestBody/content/application~1json/examples/nextMonth"]}},"responseCodes":["201","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/copy","href":"journal-entries/copyjournalentry","openApiOperationId":"copyJournalEntry","summary":"Copy a journal entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/CopyJournalEntryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/requestBody/content/application~1json/examples/nextMonth"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CopyJournalEntryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/requestBody/content/application~1json/examples/nextMonth"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Copy created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JournalEntryResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/201/content/application~1json/examples/copyCreated"]}},"schemaId":"components/schemas/JournalEntryResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/201/content/application~1json/examples/copyCreated"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1copy/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1copy/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Source entry cannot be copied; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/502/content/application~1json/examples/sourceEntryCannotBeCopied","paths/~1journal-entries~1{jeId}~1copy/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/502/content/application~1json/examples/sourceEntryCannotBeCopied","paths/~1journal-entries~1{jeId}~1copy/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1copy/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/JournalEntryResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/201/content/application~1json/examples/copyCreated"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JournalEntryResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/201/content/application~1json/examples/copyCreated"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1copy/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1copy/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/502/content/application~1json/examples/sourceEntryCannotBeCopied","paths/~1journal-entries~1{jeId}~1copy/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1copy/post/responses/502/content/application~1json/examples/sourceEntryCannotBeCopied","paths/~1journal-entries~1{jeId}~1copy/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-entries/copyjournalentry"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/copy"},{"label":"List journal entries by name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/searchjournalentriesbyname","routeSlug":"/other-api/revenue-api-3.0/journal-entries/searchjournalentriesbyname","metadata":{"seo":{"title":"List journal entries by name","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchJournalEntriesByName","name":"List journal entries by name","isWebhook":false,"pointer":"/paths/~1journal-entries~1search~1{jeName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List journal entries by name","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the journal entries whose name matches the given text. Use it for quick look-ups (for example a type-ahead); use GET /journal-entries with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter=name.SW:..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for paginated searches."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quick look-up of an entry by (part of) its name, for example in a type-ahead search box."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before retrying a create call that timed out, to check whether the entry was already created."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeName","in":"path","schemaId":"schema_3","description":"Name (or part of the name) to search for. URL-encode spaces and special characters.","required":true,"example":"SEP-2026"}],"pointer":"/paths/~1journal-entries~1search~1{jeName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/search/{jeName}","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeName","in":"path","required":true,"example":"SEP-2026","schemaId":"schema_3"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/search/{jeName}","href":"journal-entries/searchjournalentriesbyname","openApiOperationId":"searchJournalEntriesByName","summary":"List journal entries by name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Matching journal entries (may be empty)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/200/content/application~1json/examples/matchingJournalEntriesMayBeEmpty","paths/~1journal-entries~1search~1{jeName}/get/responses/200/content/application~1json/examples/noMatch"]}},"schemaId":"schema_50","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/200/content/application~1json/examples/matchingJournalEntriesMayBeEmpty","paths/~1journal-entries~1search~1{jeName}/get/responses/200/content/application~1json/examples/noMatch"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1search~1{jeName}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1search~1{jeName}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1search~1{jeName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_50","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/200/content/application~1json/examples/matchingJournalEntriesMayBeEmpty","paths/~1journal-entries~1search~1{jeName}/get/responses/200/content/application~1json/examples/noMatch"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/200/content/application~1json/examples/matchingJournalEntriesMayBeEmpty","paths/~1journal-entries~1search~1{jeName}/get/responses/200/content/application~1json/examples/noMatch"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1search~1{jeName}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1search~1{jeName}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1search~1{jeName}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-entries/searchjournalentriesbyname"}],"panels":[]}]},"httpPath":"/journal-entries/search/{jeName}"},{"label":"List journal entries for an organization and book","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entries/listjournalentriesbyorgandbook","routeSlug":"/other-api/revenue-api-3.0/journal-entries/listjournalentriesbyorgandbook","metadata":{"seo":{"title":"List journal entries for an organization and book","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listJournalEntriesByOrgAndBook","name":"List journal entries for an organization and book","isWebhook":false,"pointer":"/paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List journal entries for an organization and book","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns all journal entries for one organization and accounting book (not paginated). Use GET /journal-entries for large result sets."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You need every entry for one organization and book in a single response (small data sets, for example a nightly sync)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For large or filtered result sets use GET /journal-entries with pagination instead."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"secAtrVal","in":"path","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization ID (security attribute value), the same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"101"},{"name":"bookId","in":"path","schemaId":"schema_22","description":"Accounting book ID.","required":true,"example":1}],"pointer":"/paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/by-org/{secAtrVal}/book/{bookId}","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"secAtrVal","in":"path","required":true,"example":"101","schemaId":"schema_3"},{"name":"bookId","in":"path","required":true,"example":1,"schemaId":"schema_22"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/by-org/{secAtrVal}/book/{bookId}","href":"journal-entries/listjournalentriesbyorgandbook","openApiOperationId":"listJournalEntriesByOrgAndBook","summary":"List journal entries for an organization and book"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Journal entries for the organization and book","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/200/content/application~1json/examples/journalEntriesForTheOrganizationAndBook"]}},"schemaId":"schema_50","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/200/content/application~1json/examples/journalEntriesForTheOrganizationAndBook"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Non-numeric book ID; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/500/content/application~1json/examples/nonNumericBookId","paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/500/content/application~1json/examples/nonNumericBookId","paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_50","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/200/content/application~1json/examples/journalEntriesForTheOrganizationAndBook"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/200/content/application~1json/examples/journalEntriesForTheOrganizationAndBook"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/500/content/application~1json/examples/nonNumericBookId","paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/500/content/application~1json/examples/nonNumericBookId","paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-entries/listjournalentriesbyorgandbook"}],"panels":[]}]},"httpPath":"/journal-entries/by-org/{secAtrVal}/book/{bookId}"}],"content":{"contentType":"group","meta":{"name":"Journal Entries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Journal Entries","showPageActions":true},{"nodeType":"markdoc","content":"Create, read, list, search, update, copy and delete manual journal entries (header plus lines)."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/journal-entries","summary":"Create a journal entry","prefix":{"name":"post","color":"post"},"badges":[],"link":"/journal-entries/createjournalentry","deprecated":false},{"title":"/journal-entries","summary":"List journal entries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/journal-entries/listjournalentries","deprecated":false},{"title":"/journal-entries/query","summary":"Search journal entries (filter in body)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/journal-entries/queryjournalentries","deprecated":false},{"title":"/journal-entries/{jeId}","summary":"Retrieve a journal entry","prefix":{"name":"get","color":"get"},"badges":[],"link":"/journal-entries/getjournalentry","deprecated":false},{"title":"/journal-entries/{jeId}","summary":"Update a journal entry","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/journal-entries/updatejournalentry","deprecated":false},{"title":"/journal-entries/{jeId}","summary":"Delete a journal entry","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/journal-entries/deletejournalentry","deprecated":false},{"title":"/journal-entries/{jeId}/copy","summary":"Copy a journal entry","prefix":{"name":"post","color":"post"},"badges":[],"link":"/journal-entries/copyjournalentry","deprecated":false},{"title":"/journal-entries/search/{jeName}","summary":"List journal entries by name","prefix":{"name":"get","color":"get"},"badges":[],"link":"/journal-entries/searchjournalentriesbyname","deprecated":false},{"title":"/journal-entries/by-org/{secAtrVal}/book/{bookId}","summary":"List journal entries for an organization and book","prefix":{"name":"get","color":"get"},"badges":[],"link":"/journal-entries/listjournalentriesbyorgandbook","deprecated":false}]}]}]}]}},{"type":"group","label":"Service Health","link":"/other-api/revenue-api-3.0/service-health","routeSlug":"/other-api/revenue-api-3.0/service-health","items":[{"label":"Check service health","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/service-health/checkjournalentryservicehealth","routeSlug":"/other-api/revenue-api-3.0/service-health/checkjournalentryservicehealth","metadata":{"seo":{"title":"Check service health","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkJournalEntryServiceHealth","name":"Check service health","isWebhook":false,"pointer":"/paths/~1journal-entries~1healthcheck/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check service health","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirms that the Manual Journal Entry API and the journal entry processing service behind it are reachable. Use it in monitoring or before a batch run."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before starting a batch load or an automated close job, to fail fast if the service is unavailable."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"From monitoring or alerting tools that poll API availability."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/healthcheck","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/healthcheck","href":"service-health/checkjournalentryservicehealth","openApiOperationId":"checkJournalEntryServiceHealth","summary":"Check service health"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Service is available","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HealthCheckResponse","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/200/content/application~1json/examples/serviceIsAvailable"]}},"schemaId":"components/schemas/HealthCheckResponse","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/200/content/application~1json/examples/serviceIsAvailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1healthcheck/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1healthcheck/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1healthcheck/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/HealthCheckResponse","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/200/content/application~1json/examples/serviceIsAvailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HealthCheckResponse","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/200/content/application~1json/examples/serviceIsAvailable"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1healthcheck/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1healthcheck/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1healthcheck/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/service-health/checkjournalentryservicehealth"}],"panels":[]}]},"httpPath":"/journal-entries/healthcheck"}],"content":{"contentType":"group","meta":{"name":"Service Health"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Service Health","showPageActions":true},{"nodeType":"markdoc","content":"Check that the Manual Journal Entry API is available."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/journal-entries/healthcheck","summary":"Check service health","prefix":{"name":"get","color":"get"},"badges":[],"link":"/service-health/checkjournalentryservicehealth","deprecated":false}]}]}]}]}},{"type":"group","label":"Journal Entry Lines","link":"/other-api/revenue-api-3.0/journal-entry-lines","routeSlug":"/other-api/revenue-api-3.0/journal-entry-lines","items":[{"label":"List journal entry lines","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entry-lines/listjournalentrylines","routeSlug":"/other-api/revenue-api-3.0/journal-entry-lines/listjournalentrylines","metadata":{"seo":{"title":"List journal entry lines","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listJournalEntryLines","name":"List journal entry lines","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1lines/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List journal entry lines","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a page of the lines of a journal entry, with filtering, sorting and field selection. Each line's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" shows any validation error recorded on it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Review or reconcile the debit/credit lines of an entry, for example to show them in your own UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After validation fails ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validationStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), to find which lines have an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get line IDs before a CSV full-file update, line copy or line delete."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the page is wrapped in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JournalEntryResponse"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". With "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the page object is returned directly."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}~1lines/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter clause in the form "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field.OPERATOR:value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Repeat the parameter to combine clauses with AND. Operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (equals), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not equals), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (comparisons for numbers and dates), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (starts with) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (any of a list: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field.IN:[v1,v2]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Values are not quoted. Allowed fields for lines: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bookId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"costOrVcType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRateDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gexchangeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeSetNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcLineId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference8"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference11"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference12"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference13"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soLineId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soNum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"typeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Unknown fields return 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":["accountType.EQ:Revenue"]},{"name":"sort","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort clause "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only the first sort clause is applied. Uses the same field names as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":["id.ASC"]},{"name":"fields","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated list of properties to return for each record (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is always returned). Names must match the response property names exactly. When supplied, each record contains only these properties. Unknown names return 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":["accountCode","debit","credit"]},{"name":"expand","in":"query","schemaId":"schema_47","description":"Reserved for future use; currently ignored."},{"name":"pageSize","in":"query","schemaId":"schema_48","description":"Number of records per page. Defaults to 20. Values above 40 are reduced to 40.","example":20},{"name":"cursor","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page to return. Use the 1-based page number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", ...). Defaults to the first page. A non-numeric or non-positive value returns 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2"}],"pointer":"/paths/~1journal-entries~1{jeId}~1lines/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/{jeId}/lines","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[{"name":"filter","in":"query","required":false,"example":["accountType.EQ:Revenue"],"schemaId":"schema_47","style":"form","explode":true},{"name":"sort","in":"query","required":false,"example":["id.ASC"],"schemaId":"schema_47","style":"form","explode":true},{"name":"fields","in":"query","required":false,"example":["accountCode","debit","credit"],"schemaId":"schema_47","style":"form","explode":false},{"name":"expand","in":"query","required":false,"schemaId":"schema_47","style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"example":20,"schemaId":"schema_48"},{"name":"cursor","in":"query","required":false,"example":"2","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/lines","href":"journal-entry-lines/listjournalentrylines","openApiOperationId":"listJournalEntryLines","summary":"List journal entry lines"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Journal entry with a page of lines","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/200/content/application~1json/examples/journalEntryWithAPageOfLines","paths/~1journal-entries~1{jeId}~1lines/get/responses/200/content/application~1json/examples/projected"]}},"schemaId":"schema_51","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/200/content/application~1json/examples/journalEntryWithAPageOfLines","paths/~1journal-entries~1{jeId}~1lines/get/responses/200/content/application~1json/examples/projected"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"400","description":"Unknown filter field","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/400/content/application~1json/examples/unknownFilterField"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/400/content/application~1json/examples/unknownFilterField"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1lines/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_51","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/200/content/application~1json/examples/journalEntryWithAPageOfLines","paths/~1journal-entries~1{jeId}~1lines/get/responses/200/content/application~1json/examples/projected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_51","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/200/content/application~1json/examples/journalEntryWithAPageOfLines","paths/~1journal-entries~1{jeId}~1lines/get/responses/200/content/application~1json/examples/projected"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/400/content/application~1json/examples/unknownFilterField"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/400/content/application~1json/examples/unknownFilterField"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-entry-lines/listjournalentrylines"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/lines"},{"label":"Delete a journal entry line","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entry-lines/deletejournalentryline","routeSlug":"/other-api/revenue-api-3.0/journal-entry-lines/deletejournalentryline","metadata":{"seo":{"title":"Delete a journal entry line","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteJournalEntryLine","name":"Delete a journal entry line","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a journal entry line","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes one line from an editable journal entry. Remember to keep each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeSetNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" balanced; delete or adjust the offsetting line too."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove one incorrect line from an editable entry without re-uploading the whole entry."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For several changes at once, a CSV full-file update (PATCH) is usually simpler."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The line is identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alone. Make sure the line belongs to the entry in the path before deleting."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045},{"name":"lineId","in":"path","schemaId":"schema_30","description":"ID of the line to delete.","required":true,"example":70002}],"pointer":"/paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/journal-entries/{jeId}/lines/{lineId}","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"},{"name":"lineId","in":"path","required":true,"example":70002,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/lines/{lineId}","href":"journal-entry-lines/deletejournalentryline","openApiOperationId":"deleteJournalEntryLine","summary":"Delete a journal entry line"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Line deleted (no response body)","headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Line cannot be deleted; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/502/content/application~1json/examples/lineCannotBeDeleted","paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/502/content/application~1json/examples/lineCannotBeDeleted","paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/502/content/application~1json/examples/lineCannotBeDeleted","paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/502/content/application~1json/examples/lineCannotBeDeleted","paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-entry-lines/deletejournalentryline"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/lines/{lineId}"},{"label":"Copy journal entry lines","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entry-lines/copyjournalentrylines","routeSlug":"/other-api/revenue-api-3.0/journal-entry-lines/copyjournalentrylines","metadata":{"seo":{"title":"Copy journal entry lines","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"copyJournalEntryLines","name":"Copy journal entry lines","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1lines~1copy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Copy journal entry lines","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Copies selected lines of a journal entry, either within the same entry or into another editable entry ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetJeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Returns the newly created lines."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duplicate selected lines inside the same entry (for example to add a similar set), or reuse lines from one entry in another editable entry."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}~1lines~1copy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CopyJournalEntryLinesRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/requestBody/content/application~1json/examples/toOtherEntry"]}},"schemaId":"components/schemas/CopyJournalEntryLinesRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/requestBody/content/application~1json/examples/toOtherEntry"],"pointer":"/paths/~1journal-entries~1{jeId}~1lines~1copy/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries/{jeId}/lines/copy","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CopyJournalEntryLinesRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/requestBody/content/application~1json/examples/toOtherEntry"]}},"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/lines/copy","href":"journal-entry-lines/copyjournalentrylines","openApiOperationId":"copyJournalEntryLines","summary":"Copy journal entry lines"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/CopyJournalEntryLinesRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/requestBody/content/application~1json/examples/toOtherEntry"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CopyJournalEntryLinesRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/requestBody/content/application~1json/examples/toOtherEntry"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Copied lines","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_52","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/200/content/application~1json/examples/copiedLines"]}},"schemaId":"schema_52","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/200/content/application~1json/examples/copiedLines"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Target entry not editable; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/502/content/application~1json/examples/targetEntryNotEditable","paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/502/content/application~1json/examples/targetEntryNotEditable","paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_52","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/200/content/application~1json/examples/copiedLines"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_52","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/200/content/application~1json/examples/copiedLines"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/502/content/application~1json/examples/targetEntryNotEditable","paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/502/content/application~1json/examples/targetEntryNotEditable","paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-entry-lines/copyjournalentrylines"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/lines/copy"},{"label":"List journal entry lines by sales order number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/journal-entry-lines/searchjournalentrylinesbysalesorder","routeSlug":"/other-api/revenue-api-3.0/journal-entry-lines/searchjournalentrylinesbysalesorder","metadata":{"seo":{"title":"List journal entry lines by sales order number","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchJournalEntryLinesBySalesOrder","name":"List journal entry lines by sales order number","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List journal entry lines by sales order number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the lines of a journal entry that reference the given sales order number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soNum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find the lines of an entry that relate to a specific sales order, for example when an auditor or customer asks about one order."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045},{"name":"soNumber","in":"path","schemaId":"schema_3","description":"Sales order number to search for.","required":true,"example":"SO-50012"}],"pointer":"/paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/{jeId}/lines/search/{soNumber}","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"},{"name":"soNumber","in":"path","required":true,"example":"SO-50012","schemaId":"schema_3"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/lines/search/{soNumber}","href":"journal-entry-lines/searchjournalentrylinesbysalesorder","openApiOperationId":"searchJournalEntryLinesBySalesOrder","summary":"List journal entry lines by sales order number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Matching lines (may be empty)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/200/content/application~1json/examples/matchingLinesMayBeEmpty","paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/200/content/application~1json/examples/noMatch"]}},"schemaId":"schema_53","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/200/content/application~1json/examples/matchingLinesMayBeEmpty","paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/200/content/application~1json/examples/noMatch"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_53","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/200/content/application~1json/examples/matchingLinesMayBeEmpty","paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/200/content/application~1json/examples/noMatch"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/200/content/application~1json/examples/matchingLinesMayBeEmpty","paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/200/content/application~1json/examples/noMatch"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/journal-entry-lines/searchjournalentrylinesbysalesorder"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/lines/search/{soNumber}"}],"content":{"contentType":"group","meta":{"name":"Journal Entry Lines"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Journal Entry Lines","showPageActions":true},{"nodeType":"markdoc","content":"List, search, copy and delete the debit/credit lines of a journal entry."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/journal-entries/{jeId}/lines","summary":"List journal entry lines","prefix":{"name":"get","color":"get"},"badges":[],"link":"/journal-entry-lines/listjournalentrylines","deprecated":false},{"title":"/journal-entries/{jeId}/lines/{lineId}","summary":"Delete a journal entry line","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/journal-entry-lines/deletejournalentryline","deprecated":false},{"title":"/journal-entries/{jeId}/lines/copy","summary":"Copy journal entry lines","prefix":{"name":"post","color":"post"},"badges":[],"link":"/journal-entry-lines/copyjournalentrylines","deprecated":false},{"title":"/journal-entries/{jeId}/lines/search/{soNumber}","summary":"List journal entry lines by sales order number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/journal-entry-lines/searchjournalentrylinesbysalesorder","deprecated":false}]}]}]}]}},{"type":"group","label":"Schedules and Waterfall","link":"/other-api/revenue-api-3.0/schedules-and-waterfall","routeSlug":"/other-api/revenue-api-3.0/schedules-and-waterfall","items":[{"label":"List journal entry schedules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/schedules-and-waterfall/listjournalentryschedules","routeSlug":"/other-api/revenue-api-3.0/schedules-and-waterfall/listjournalentryschedules","metadata":{"seo":{"title":"List journal entry schedules","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listJournalEntrySchedules","name":"List journal entry schedules","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1schedules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List journal entry schedules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a page of the revenue schedules (period-by-period accounting entries) that a journal entry generates. Available once waterfall generation has succeeded ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waterfallStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the period-by-period accounting (debits/credits by account and period) the entry produces, for GL reconciliation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available after waterfall generation has succeeded ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waterfallStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}~1schedules/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter clause in the form "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field.OPERATOR:value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Repeat the parameter to combine clauses with AND. Operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (equals), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not equals), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (comparisons for numbers and dates), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (starts with) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (any of a list: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field.IN:[v1,v2]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Values are not quoted. Allowed fields for schedules: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"acountCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"crAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funcDrAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funcCrAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcurrDrAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcurrCrAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schdRcId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Unknown fields return 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":["periodName.EQ:SEP-2026"]},{"name":"sort","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort clause "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only the first sort clause is applied. Uses the same field names as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":["periodName.ASC"]},{"name":"fields","in":"query","schemaId":"schema_47","description":"Accepted for consistency with other list endpoints; not applied by this endpoint."},{"name":"expand","in":"query","schemaId":"schema_47","description":"Reserved for future use; currently ignored."},{"name":"pageSize","in":"query","schemaId":"schema_48","description":"Number of records per page. Defaults to 20. Values above 40 are reduced to 40.","example":20},{"name":"cursor","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page to return. Use the 1-based page number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", ...). Defaults to the first page. A non-numeric or non-positive value returns 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2"}],"pointer":"/paths/~1journal-entries~1{jeId}~1schedules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/{jeId}/schedules","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[{"name":"filter","in":"query","required":false,"example":["periodName.EQ:SEP-2026"],"schemaId":"schema_47","style":"form","explode":true},{"name":"sort","in":"query","required":false,"example":["periodName.ASC"],"schemaId":"schema_47","style":"form","explode":true},{"name":"fields","in":"query","required":false,"schemaId":"schema_47","style":"form","explode":false},{"name":"expand","in":"query","required":false,"schemaId":"schema_47","style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"example":20,"schemaId":"schema_48"},{"name":"cursor","in":"query","required":false,"example":"2","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/schedules","href":"schedules-and-waterfall/listjournalentryschedules","openApiOperationId":"listJournalEntrySchedules","summary":"List journal entry schedules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Journal entry with a page of schedules","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JournalEntryResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/200/content/application~1json/examples/journalEntryWithAPageOfSchedules"]}},"schemaId":"components/schemas/JournalEntryResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/200/content/application~1json/examples/journalEntryWithAPageOfSchedules"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"400","description":"Unknown filter field","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/400/content/application~1json/examples/unknownFilterField"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/400/content/application~1json/examples/unknownFilterField"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1schedules/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1schedules/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1schedules/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/JournalEntryResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/200/content/application~1json/examples/journalEntryWithAPageOfSchedules"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/JournalEntryResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/200/content/application~1json/examples/journalEntryWithAPageOfSchedules"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/400/content/application~1json/examples/unknownFilterField"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/400/content/application~1json/examples/unknownFilterField"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1schedules/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1schedules/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedules-and-waterfall/listjournalentryschedules"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/schedules"},{"label":"List revenue waterfall entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/schedules-and-waterfall/listjournalentrywaterfallentries","routeSlug":"/other-api/revenue-api-3.0/schedules-and-waterfall/listjournalentrywaterfallentries","metadata":{"seo":{"title":"List revenue waterfall entries","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listJournalEntryWaterfallEntries","name":"List revenue waterfall entries","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1waterfall-entries/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List revenue waterfall entries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a page of the revenue waterfall for a journal entry: for each line, the amount recognized in each period. Use it to review the revenue impact before approving."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview the revenue impact of an entry by period before approving it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Explain to stakeholders how an adjustment changes future revenue."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}~1waterfall-entries/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter clause in the form "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field.OPERATOR:value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Repeat the parameter to combine clauses with AND. Operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EQ"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (equals), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not equals), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (comparisons for numbers and dates), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (starts with) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (any of a list: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field.IN:[v1,v2]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Values are not quoted. Allowed fields for waterfall entries: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeSetNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soLineId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Unknown fields return 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":["accountType.EQ:Revenue"]},{"name":"sort","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort clause "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field.ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field.DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only the first sort clause is applied. Uses the same field names as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":["jeSetNo.ASC"]},{"name":"fields","in":"query","schemaId":"schema_47","description":"Accepted for consistency with other list endpoints; not applied by this endpoint."},{"name":"expand","in":"query","schemaId":"schema_47","description":"Reserved for future use; currently ignored."},{"name":"pageSize","in":"query","schemaId":"schema_48","description":"Number of records per page. Defaults to 20. Values above 40 are reduced to 40.","example":20},{"name":"cursor","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page to return. Use the 1-based page number ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", ...). Defaults to the first page. A non-numeric or non-positive value returns 400 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2"}],"pointer":"/paths/~1journal-entries~1{jeId}~1waterfall-entries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/{jeId}/waterfall-entries","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[{"name":"filter","in":"query","required":false,"example":["accountType.EQ:Revenue"],"schemaId":"schema_47","style":"form","explode":true},{"name":"sort","in":"query","required":false,"example":["jeSetNo.ASC"],"schemaId":"schema_47","style":"form","explode":true},{"name":"fields","in":"query","required":false,"schemaId":"schema_47","style":"form","explode":false},{"name":"expand","in":"query","required":false,"schemaId":"schema_47","style":"form","explode":false},{"name":"pageSize","in":"query","required":false,"example":20,"schemaId":"schema_48"},{"name":"cursor","in":"query","required":false,"example":"2","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/waterfall-entries","href":"schedules-and-waterfall/listjournalentrywaterfallentries","openApiOperationId":"listJournalEntryWaterfallEntries","summary":"List revenue waterfall entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Page of waterfall entries","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WaterfallEntriesPage","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/200/content/application~1json/examples/pageOfWaterfallEntries"]}},"schemaId":"components/schemas/WaterfallEntriesPage","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/200/content/application~1json/examples/pageOfWaterfallEntries"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"400","description":"Unknown filter field","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/400/content/application~1json/examples/unknownFilterField"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/400/content/application~1json/examples/unknownFilterField"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WaterfallEntriesPage","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/200/content/application~1json/examples/pageOfWaterfallEntries"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WaterfallEntriesPage","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/200/content/application~1json/examples/pageOfWaterfallEntries"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/400/content/application~1json/examples/unknownFilterField"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/400/content/application~1json/examples/unknownFilterField"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedules-and-waterfall/listjournalentrywaterfallentries"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/waterfall-entries"},{"label":"Retrieve the waterfall status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/schedules-and-waterfall/getjournalentrywaterfallstatus","routeSlug":"/other-api/revenue-api-3.0/schedules-and-waterfall/getjournalentrywaterfallstatus","metadata":{"seo":{"title":"Retrieve the waterfall status","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJournalEntryWaterfallStatus","name":"Retrieve the waterfall status","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1waterfall-status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the waterfall status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the status of waterfall (schedule) generation for a journal entry. Poll this after create, update or approval until it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Poll after create, update or approval until waterfall generation finishes ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), before reading schedules or waterfall entries."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For an ID that does not exist, the call returns HTTP 200 with an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waterfallStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}~1waterfall-status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/{jeId}/waterfall-status","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/waterfall-status","href":"schedules-and-waterfall/getjournalentrywaterfallstatus","openApiOperationId":"getJournalEntryWaterfallStatus","summary":"Retrieve the waterfall status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Waterfall status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WaterfallStatusResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/200/content/application~1json/examples/waterfallStatus","paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/200/content/application~1json/examples/inProgress"]}},"schemaId":"components/schemas/WaterfallStatusResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/200/content/application~1json/examples/waterfallStatus","paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/200/content/application~1json/examples/inProgress"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Non-numeric ID; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/500/content/application~1json/examples/nonNumericId","paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/500/content/application~1json/examples/nonNumericId","paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WaterfallStatusResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/200/content/application~1json/examples/waterfallStatus","paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/200/content/application~1json/examples/inProgress"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WaterfallStatusResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/200/content/application~1json/examples/waterfallStatus","paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/200/content/application~1json/examples/inProgress"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/500/content/application~1json/examples/nonNumericId","paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/500/content/application~1json/examples/nonNumericId","paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedules-and-waterfall/getjournalentrywaterfallstatus"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/waterfall-status"},{"label":"Retry waterfall generation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/schedules-and-waterfall/retryjournalentrywaterfall","routeSlug":"/other-api/revenue-api-3.0/schedules-and-waterfall/retryjournalentrywaterfall","metadata":{"seo":{"title":"Retry waterfall generation","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retryJournalEntryWaterfall","name":"Retry waterfall generation","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1waterfall-retry/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retry waterfall generation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Re-triggers waterfall (schedule) generation for a journal entry whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waterfallStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Returns the new status, normally "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Waterfall generation ended in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example after a temporary issue) and you want to run it again without editing the entry."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}~1waterfall-retry/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries/{jeId}/waterfall-retry","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/waterfall-retry","href":"schedules-and-waterfall/retryjournalentrywaterfall","openApiOperationId":"retryJournalEntryWaterfall","summary":"Retry waterfall generation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Waterfall generation re-triggered","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WaterfallStatusResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/200/content/application~1json/examples/waterfallGenerationReTriggered"]}},"schemaId":"components/schemas/WaterfallStatusResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/200/content/application~1json/examples/waterfallGenerationReTriggered"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Retry not allowed; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/502/content/application~1json/examples/retryNotAllowed","paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/502/content/application~1json/examples/retryNotAllowed","paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WaterfallStatusResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/200/content/application~1json/examples/waterfallGenerationReTriggered"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WaterfallStatusResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/200/content/application~1json/examples/waterfallGenerationReTriggered"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/502/content/application~1json/examples/retryNotAllowed","paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/502/content/application~1json/examples/retryNotAllowed","paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedules-and-waterfall/retryjournalentrywaterfall"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/waterfall-retry"}],"content":{"contentType":"group","meta":{"name":"Schedules and Waterfall"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schedules and Waterfall","showPageActions":true},{"nodeType":"markdoc","content":"Inspect the revenue schedules and revenue waterfall generated from a journal entry, and retry waterfall generation."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/journal-entries/{jeId}/schedules","summary":"List journal entry schedules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schedules-and-waterfall/listjournalentryschedules","deprecated":false},{"title":"/journal-entries/{jeId}/waterfall-entries","summary":"List revenue waterfall entries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schedules-and-waterfall/listjournalentrywaterfallentries","deprecated":false},{"title":"/journal-entries/{jeId}/waterfall-status","summary":"Retrieve the waterfall status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schedules-and-waterfall/getjournalentrywaterfallstatus","deprecated":false},{"title":"/journal-entries/{jeId}/waterfall-retry","summary":"Retry waterfall generation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/schedules-and-waterfall/retryjournalentrywaterfall","deprecated":false}]}]}]}]}},{"type":"group","label":"Approval Workflow","link":"/other-api/revenue-api-3.0/approval-workflow","routeSlug":"/other-api/revenue-api-3.0/approval-workflow","items":[{"label":"Submit a journal entry for approval","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/submitjournalentry","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/submitjournalentry","metadata":{"seo":{"title":"Submit a journal entry for approval","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"submitJournalEntry","name":"Submit a journal entry for approval","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1submit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a journal entry for approval","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submits a validated journal entry into the approval workflow. The approval rule that matches the entry determines the approvers; if no approval rule matches, the submit is refused. Only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of the body is used."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entry is complete and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Validated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and should now go to its approvers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Call GET /journal-entries/{jeId}/validation-status first; submitting an entry with line errors fails."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}~1submit/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional client-generated unique key (for example a UUID). Accepted for forward compatibility; "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not currently enforced"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the service does not de-duplicate retries, so do not rely on it to prevent duplicate entries."},"children":[]}]}]}],"example":"6f1c2c3e-0b7a-4d1e-9a51-1f1e2a3b4c5d"}],"pointer":"/paths/~1journal-entries~1{jeId}~1submit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/requestBody/content/application~1json/examples/withComment"]}},"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/requestBody/content/application~1json/examples/withComment"],"pointer":"/paths/~1journal-entries~1{jeId}~1submit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries/{jeId}/submit","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"example":"6f1c2c3e-0b7a-4d1e-9a51-1f1e2a3b4c5d","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/requestBody/content/application~1json/examples/withComment"]}},"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/submit","href":"approval-workflow/submitjournalentry","openApiOperationId":"submitJournalEntry","summary":"Submit a journal entry for approval"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/requestBody/content/application~1json/examples/withComment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/requestBody/content/application~1json/examples/withComment"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Entry submitted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/200/content/application~1json/examples/entrySubmitted"]}},"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/200/content/application~1json/examples/entrySubmitted"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1submit/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1submit/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Entry has validation errors; No approval rule; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/entryHasValidationErrors","paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/noApprovalRule","paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/entryHasValidationErrors","paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/noApprovalRule","paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1submit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/200/content/application~1json/examples/entrySubmitted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/200/content/application~1json/examples/entrySubmitted"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1submit/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1submit/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/entryHasValidationErrors","paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/noApprovalRule","paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/entryHasValidationErrors","paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/noApprovalRule","paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/approval-workflow/submitjournalentry"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/submit"},{"label":"Approve journal entries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/approvejournalentries","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/approvejournalentries","metadata":{"seo":{"title":"Approve journal entries","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"approveJournalEntries","name":"Approve journal entries","isWebhook":false,"pointer":"/paths/~1journal-entries~1approve/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Approve journal entries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approves one or more journal entries that are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and assigned to the caller. On final approval the entry's schedules are posted and the final waterfall is generated asynchronously (track it with GET /journal-entries/{jeId}/waterfall-status)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An approver (or an approval step in your workflow tool) accepts one or more entries that are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approving several entries at once during period close."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the response and on every item in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". HTTP 200 is also returned when "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry failed; HTTP 207 means a mix of successes and failures."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" item currently reports the entry inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be omitted."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional client-generated unique key (for example a UUID). Accepted for forward compatibility; "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not currently enforced"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the service does not de-duplicate retries, so do not rely on it to prevent duplicate entries."},"children":[]}]}]}],"example":"6f1c2c3e-0b7a-4d1e-9a51-1f1e2a3b4c5d"}],"pointer":"/paths/~1journal-entries~1approve/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1approve/post/requestBody/content/application~1json/examples/example"]}},"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1approve/post/requestBody/content/application~1json/examples/example"],"pointer":"/paths/~1journal-entries~1approve/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries/approve","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"example":"6f1c2c3e-0b7a-4d1e-9a51-1f1e2a3b4c5d","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1approve/post/requestBody/content/application~1json/examples/example"]}},"responseCodes":["200","207","401","403","429","500","502"],"pointer":"/journal-entries/approve","href":"approval-workflow/approvejournalentries","openApiOperationId":"approveJournalEntries","summary":"Approve journal entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1approve/post/requestBody/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1approve/post/requestBody/content/application~1json/examples/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All entries approved","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/200/content/application~1json/examples/allEntriesApproved","paths/~1journal-entries~1approve/post/responses/200/content/application~1json/examples/allFailed"]}},"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/200/content/application~1json/examples/allEntriesApproved","paths/~1journal-entries~1approve/post/responses/200/content/application~1json/examples/allFailed"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"207","description":"Some entries succeeded and some failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"]}},"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1approve/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1approve/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1approve/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1approve/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1approve/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1approve/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Action rejected; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1approve/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1approve/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1approve/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/200/content/application~1json/examples/allEntriesApproved","paths/~1journal-entries~1approve/post/responses/200/content/application~1json/examples/allFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/200/content/application~1json/examples/allEntriesApproved","paths/~1journal-entries~1approve/post/responses/200/content/application~1json/examples/allFailed"]}}},{"code":"207","schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1approve/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1approve/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1approve/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1approve/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1approve/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1approve/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1approve/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1approve/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1approve/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/approval-workflow/approvejournalentries"}],"panels":[]}]},"httpPath":"/journal-entries/approve"},{"label":"Reject journal entries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/rejectjournalentries","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/rejectjournalentries","metadata":{"seo":{"title":"Reject journal entries","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rejectJournalEntries","name":"Reject journal entries","isWebhook":false,"pointer":"/paths/~1journal-entries~1reject/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reject journal entries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rejects one or more journal entries that are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Rejected entries can be edited and resubmitted. Provide a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining the rejection; it is stored in the audit trail."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An approver sends one or more entries back to the preparer for correction. Always include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explaining why."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the response and on every item in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". HTTP 200 is also returned when "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry failed; HTTP 207 means a mix of successes and failures."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" item currently reports the entry inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be omitted."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional client-generated unique key (for example a UUID). Accepted for forward compatibility; "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not currently enforced"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the service does not de-duplicate retries, so do not rely on it to prevent duplicate entries."},"children":[]}]}]}],"example":"6f1c2c3e-0b7a-4d1e-9a51-1f1e2a3b4c5d"}],"pointer":"/paths/~1journal-entries~1reject/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1reject/post/requestBody/content/application~1json/examples/example"]}},"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1reject/post/requestBody/content/application~1json/examples/example"],"pointer":"/paths/~1journal-entries~1reject/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries/reject","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"example":"6f1c2c3e-0b7a-4d1e-9a51-1f1e2a3b4c5d","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1reject/post/requestBody/content/application~1json/examples/example"]}},"responseCodes":["200","207","401","403","429","500","502"],"pointer":"/journal-entries/reject","href":"approval-workflow/rejectjournalentries","openApiOperationId":"rejectJournalEntries","summary":"Reject journal entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1reject/post/requestBody/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1reject/post/requestBody/content/application~1json/examples/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All entries rejected","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/200/content/application~1json/examples/allEntriesRejected","paths/~1journal-entries~1reject/post/responses/200/content/application~1json/examples/allFailed"]}},"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/200/content/application~1json/examples/allEntriesRejected","paths/~1journal-entries~1reject/post/responses/200/content/application~1json/examples/allFailed"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"207","description":"Some entries succeeded and some failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"]}},"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1reject/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1reject/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1reject/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1reject/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1reject/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1reject/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Action rejected; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1reject/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1reject/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1reject/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/200/content/application~1json/examples/allEntriesRejected","paths/~1journal-entries~1reject/post/responses/200/content/application~1json/examples/allFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/200/content/application~1json/examples/allEntriesRejected","paths/~1journal-entries~1reject/post/responses/200/content/application~1json/examples/allFailed"]}}},{"code":"207","schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1reject/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1reject/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1reject/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1reject/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1reject/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1reject/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1reject/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reject/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1reject/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/approval-workflow/rejectjournalentries"}],"panels":[]}]},"httpPath":"/journal-entries/reject"},{"label":"Recall journal entries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/recalljournalentries","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/recalljournalentries","metadata":{"seo":{"title":"Recall journal entries","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"recallJournalEntries","name":"Recall journal entries","isWebhook":false,"pointer":"/paths/~1journal-entries~1recall/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recall journal entries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Withdraws one or more submitted journal entries from approval so they can be edited again. Usually performed by the submitter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The submitter notices a mistake after submitting and wants to withdraw the entry from approval to edit it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the response and on every item in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". HTTP 200 is also returned when "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry failed; HTTP 207 means a mix of successes and failures."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" item currently reports the entry inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be omitted."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional client-generated unique key (for example a UUID). Accepted for forward compatibility; "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not currently enforced"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the service does not de-duplicate retries, so do not rely on it to prevent duplicate entries."},"children":[]}]}]}],"example":"6f1c2c3e-0b7a-4d1e-9a51-1f1e2a3b4c5d"}],"pointer":"/paths/~1journal-entries~1recall/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1recall/post/requestBody/content/application~1json/examples/example"]}},"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1recall/post/requestBody/content/application~1json/examples/example"],"pointer":"/paths/~1journal-entries~1recall/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries/recall","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"example":"6f1c2c3e-0b7a-4d1e-9a51-1f1e2a3b4c5d","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1recall/post/requestBody/content/application~1json/examples/example"]}},"responseCodes":["200","207","401","403","429","500","502"],"pointer":"/journal-entries/recall","href":"approval-workflow/recalljournalentries","openApiOperationId":"recallJournalEntries","summary":"Recall journal entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1recall/post/requestBody/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1recall/post/requestBody/content/application~1json/examples/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All entries recalled","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/200/content/application~1json/examples/allEntriesRecalled","paths/~1journal-entries~1recall/post/responses/200/content/application~1json/examples/allFailed"]}},"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/200/content/application~1json/examples/allEntriesRecalled","paths/~1journal-entries~1recall/post/responses/200/content/application~1json/examples/allFailed"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"207","description":"Some entries succeeded and some failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"]}},"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1recall/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1recall/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1recall/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1recall/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1recall/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1recall/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Action rejected; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1recall/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1recall/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1recall/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/200/content/application~1json/examples/allEntriesRecalled","paths/~1journal-entries~1recall/post/responses/200/content/application~1json/examples/allFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/200/content/application~1json/examples/allEntriesRecalled","paths/~1journal-entries~1recall/post/responses/200/content/application~1json/examples/allFailed"]}}},{"code":"207","schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1recall/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1recall/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1recall/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1recall/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1recall/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1recall/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1recall/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1recall/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1recall/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/approval-workflow/recalljournalentries"}],"panels":[]}]},"httpPath":"/journal-entries/recall"},{"label":"Reverse a journal entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/reversejournalentry","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/reversejournalentry","metadata":{"seo":{"title":"Reverse a journal entry","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reverseJournalEntry","name":"Reverse a journal entry","isWebhook":false,"pointer":"/paths/~1journal-entries~1reverse/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reverse a journal entry","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates the reversal of an approved journal entry in the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversalPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Exactly one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversalPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An approved entry must be undone (fully offset) in a later period - for example an accrual that reverses next month, or an approved entry that turned out to be wrong."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the response and on every item in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". HTTP 200 is also returned when "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry failed; HTTP 207 means a mix of successes and failures."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" item currently reports the entry inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be omitted."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional client-generated unique key (for example a UUID). Accepted for forward compatibility; "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not currently enforced"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the service does not de-duplicate retries, so do not rely on it to prevent duplicate entries."},"children":[]}]}]}],"example":"6f1c2c3e-0b7a-4d1e-9a51-1f1e2a3b4c5d"}],"pointer":"/paths/~1journal-entries~1reverse/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1reverse/post/requestBody/content/application~1json/examples/example"]}},"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1reverse/post/requestBody/content/application~1json/examples/example"],"pointer":"/paths/~1journal-entries~1reverse/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries/reverse","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"example":"6f1c2c3e-0b7a-4d1e-9a51-1f1e2a3b4c5d","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1reverse/post/requestBody/content/application~1json/examples/example"]}},"responseCodes":["200","400","401","403","429","500","502"],"pointer":"/journal-entries/reverse","href":"approval-workflow/reversejournalentry","openApiOperationId":"reverseJournalEntry","summary":"Reverse a journal entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1reverse/post/requestBody/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1reverse/post/requestBody/content/application~1json/examples/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Entry reversed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/200/content/application~1json/examples/entryReversed","paths/~1journal-entries~1reverse/post/responses/200/content/application~1json/examples/allFailed"]}},"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/200/content/application~1json/examples/entryReversed","paths/~1journal-entries~1reverse/post/responses/200/content/application~1json/examples/allFailed"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"400","description":"More than one entry; Reversal period missing","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/400/content/application~1json/examples/moreThanOneEntry","paths/~1journal-entries~1reverse/post/responses/400/content/application~1json/examples/reversalPeriodMissing"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/400/content/application~1json/examples/moreThanOneEntry","paths/~1journal-entries~1reverse/post/responses/400/content/application~1json/examples/reversalPeriodMissing"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1reverse/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1reverse/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1reverse/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1reverse/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1reverse/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1reverse/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Action rejected; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1reverse/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1reverse/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1reverse/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/200/content/application~1json/examples/entryReversed","paths/~1journal-entries~1reverse/post/responses/200/content/application~1json/examples/allFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/200/content/application~1json/examples/entryReversed","paths/~1journal-entries~1reverse/post/responses/200/content/application~1json/examples/allFailed"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/400/content/application~1json/examples/moreThanOneEntry","paths/~1journal-entries~1reverse/post/responses/400/content/application~1json/examples/reversalPeriodMissing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/400/content/application~1json/examples/moreThanOneEntry","paths/~1journal-entries~1reverse/post/responses/400/content/application~1json/examples/reversalPeriodMissing"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1reverse/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1reverse/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1reverse/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1reverse/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1reverse/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1reverse/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1reverse/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1reverse/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1reverse/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/approval-workflow/reversejournalentry"}],"panels":[]}]},"httpPath":"/journal-entries/reverse"},{"label":"Delete several journal entries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/bulkdeletejournalentries","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/bulkdeletejournalentries","metadata":{"seo":{"title":"Delete several journal entries","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"bulkDeleteJournalEntries","name":"Delete several journal entries","isWebhook":false,"pointer":"/paths/~1journal-entries~1bulk-delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete several journal entries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes one or more journal entries that have not been approved. Entries that cannot be deleted are reported individually."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clean up several draft or rejected entries in one call, for example after a failed batch load."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the response and on every item in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". HTTP 200 is also returned when "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entry failed; HTTP 207 means a mix of successes and failures."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" item currently reports the entry inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be omitted."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional client-generated unique key (for example a UUID). Accepted for forward compatibility; "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not currently enforced"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the service does not de-duplicate retries, so do not rely on it to prevent duplicate entries."},"children":[]}]}]}],"example":"6f1c2c3e-0b7a-4d1e-9a51-1f1e2a3b4c5d"}],"pointer":"/paths/~1journal-entries~1bulk-delete/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1bulk-delete/post/requestBody/content/application~1json/examples/example"]}},"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1bulk-delete/post/requestBody/content/application~1json/examples/example"],"pointer":"/paths/~1journal-entries~1bulk-delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries/bulk-delete","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":false,"example":"6f1c2c3e-0b7a-4d1e-9a51-1f1e2a3b4c5d","schemaId":"schema_3"}],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1bulk-delete/post/requestBody/content/application~1json/examples/example"]}},"responseCodes":["200","207","401","403","429","500","502"],"pointer":"/journal-entries/bulk-delete","href":"approval-workflow/bulkdeletejournalentries","openApiOperationId":"bulkDeleteJournalEntries","summary":"Delete several journal entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1bulk-delete/post/requestBody/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatusRequest","exampleIds":["paths/~1journal-entries~1bulk-delete/post/requestBody/content/application~1json/examples/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"All entries deleted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/200/content/application~1json/examples/allEntriesDeleted","paths/~1journal-entries~1bulk-delete/post/responses/200/content/application~1json/examples/allFailed"]}},"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/200/content/application~1json/examples/allEntriesDeleted","paths/~1journal-entries~1bulk-delete/post/responses/200/content/application~1json/examples/allFailed"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"207","description":"Some entries succeeded and some failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"]}},"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1bulk-delete/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1bulk-delete/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Action rejected; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1bulk-delete/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1bulk-delete/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1bulk-delete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/200/content/application~1json/examples/allEntriesDeleted","paths/~1journal-entries~1bulk-delete/post/responses/200/content/application~1json/examples/allFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/200/content/application~1json/examples/allEntriesDeleted","paths/~1journal-entries~1bulk-delete/post/responses/200/content/application~1json/examples/allFailed"]}}},{"code":"207","schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkActionResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1bulk-delete/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1bulk-delete/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1bulk-delete/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1bulk-delete/post/responses/502/content/application~1json/examples/actionRejected","paths/~1journal-entries~1bulk-delete/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/approval-workflow/bulkdeletejournalentries"}],"panels":[]}]},"httpPath":"/journal-entries/bulk-delete"},{"label":"Check allowed actions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/getjournalentryprivileges","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/getjournalentryprivileges","metadata":{"seo":{"title":"Check allowed actions","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJournalEntryPrivileges","name":"Check allowed actions","isWebhook":false,"pointer":"/paths/~1journal-entries~1privileges/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check allowed actions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tells you which actions (submit, approve, reject, recall, delete, update, reverse) the caller may perform on the selected journal entries right now, considering their status, the approval rule, soft freeze and the caller's role. Call it before showing action buttons or before running an automated workflow step."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Decide which actions to offer a user (show or hide Submit, Approve, Delete ... buttons) in your own UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check up front, in an automated workflow, whether a step will be allowed before calling it."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PrivilegesRequest","exampleIds":["paths/~1journal-entries~1privileges/post/requestBody/content/application~1json/examples/single"]}},"schemaId":"components/schemas/PrivilegesRequest","exampleIds":["paths/~1journal-entries~1privileges/post/requestBody/content/application~1json/examples/single"],"pointer":"/paths/~1journal-entries~1privileges/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries/privileges","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PrivilegesRequest","exampleIds":["paths/~1journal-entries~1privileges/post/requestBody/content/application~1json/examples/single"]}},"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/privileges","href":"approval-workflow/getjournalentryprivileges","openApiOperationId":"getJournalEntryPrivileges","summary":"Check allowed actions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/PrivilegesRequest","exampleIds":["paths/~1journal-entries~1privileges/post/requestBody/content/application~1json/examples/single"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PrivilegesRequest","exampleIds":["paths/~1journal-entries~1privileges/post/requestBody/content/application~1json/examples/single"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Allowed actions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Privileges","exampleIds":["paths/~1journal-entries~1privileges/post/responses/200/content/application~1json/examples/allowedActions"]}},"schemaId":"components/schemas/Privileges","exampleIds":["paths/~1journal-entries~1privileges/post/responses/200/content/application~1json/examples/allowedActions"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1privileges/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1privileges/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1privileges/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1privileges/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1privileges/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1privileges/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1privileges/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1privileges/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Malformed body; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1privileges/post/responses/500/content/application~1json/examples/malformedBody","paths/~1journal-entries~1privileges/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1privileges/post/responses/500/content/application~1json/examples/malformedBody","paths/~1journal-entries~1privileges/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1privileges/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1privileges/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1privileges/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Privileges","exampleIds":["paths/~1journal-entries~1privileges/post/responses/200/content/application~1json/examples/allowedActions"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Privileges","exampleIds":["paths/~1journal-entries~1privileges/post/responses/200/content/application~1json/examples/allowedActions"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1privileges/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1privileges/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1privileges/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1privileges/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1privileges/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1privileges/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1privileges/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1privileges/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1privileges/post/responses/500/content/application~1json/examples/malformedBody","paths/~1journal-entries~1privileges/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1privileges/post/responses/500/content/application~1json/examples/malformedBody","paths/~1journal-entries~1privileges/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1privileges/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1privileges/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/approval-workflow/getjournalentryprivileges"}],"panels":[]}]},"httpPath":"/journal-entries/privileges"},{"label":"List journal entry audit events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/listjournalentryevents","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/listjournalentryevents","metadata":{"seo":{"title":"List journal entry audit events","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listJournalEntryEvents","name":"List journal entry audit events","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List journal entry audit events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the audit trail of a journal entry: who saved, updated, submitted, approved, rejected, recalled or deleted it, when, and with which comment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Audit and compliance reviews: who created, changed, submitted, approved or rejected an entry, and when."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Show the history and approval comments of an entry."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/{jeId}/events","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/events","href":"approval-workflow/listjournalentryevents","openApiOperationId":"listJournalEntryEvents","summary":"List journal entry audit events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Audit events (oldest first)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_54","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/200/content/application~1json/examples/auditEventsOldestFirst"]}},"schemaId":"schema_54","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/200/content/application~1json/examples/auditEventsOldestFirst"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1events/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1events/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Non-numeric ID; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/500/content/application~1json/examples/nonNumericId","paths/~1journal-entries~1{jeId}~1events/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/500/content/application~1json/examples/nonNumericId","paths/~1journal-entries~1{jeId}~1events/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1events/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_54","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/200/content/application~1json/examples/auditEventsOldestFirst"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_54","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/200/content/application~1json/examples/auditEventsOldestFirst"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1events/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1events/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/500/content/application~1json/examples/nonNumericId","paths/~1journal-entries~1{jeId}~1events/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/500/content/application~1json/examples/nonNumericId","paths/~1journal-entries~1{jeId}~1events/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1events/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/approval-workflow/listjournalentryevents"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/events"},{"label":"Retrieve the validation status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/approval-workflow/getjournalentryvalidationstatus","routeSlug":"/other-api/revenue-api-3.0/approval-workflow/getjournalentryvalidationstatus","metadata":{"seo":{"title":"Retrieve the validation status","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJournalEntryValidationStatus","name":"Retrieve the validation status","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1validation-status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the validation status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the progress of asynchronous line validation for a journal entry. Poll after create or update; submit when the status is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Validated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", read the lines' "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values (GET /journal-entries/{jeId}/lines) and correct them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Poll after create or update until validation finishes, then either submit ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Validated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or fix the lines ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For an ID that does not exist, the call returns HTTP 200 with an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validationStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}~1validation-status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/{jeId}/validation-status","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/validation-status","href":"approval-workflow/getjournalentryvalidationstatus","openApiOperationId":"getJournalEntryValidationStatus","summary":"Retrieve the validation status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Validation status","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationStatusResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/200/content/application~1json/examples/validationStatus","paths/~1journal-entries~1{jeId}~1validation-status/get/responses/200/content/application~1json/examples/errors"]}},"schemaId":"components/schemas/ValidationStatusResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/200/content/application~1json/examples/validationStatus","paths/~1journal-entries~1{jeId}~1validation-status/get/responses/200/content/application~1json/examples/errors"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1validation-status/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1validation-status/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Non-numeric ID; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/500/content/application~1json/examples/nonNumericId","paths/~1journal-entries~1{jeId}~1validation-status/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/500/content/application~1json/examples/nonNumericId","paths/~1journal-entries~1{jeId}~1validation-status/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1validation-status/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ValidationStatusResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/200/content/application~1json/examples/validationStatus","paths/~1journal-entries~1{jeId}~1validation-status/get/responses/200/content/application~1json/examples/errors"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationStatusResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/200/content/application~1json/examples/validationStatus","paths/~1journal-entries~1{jeId}~1validation-status/get/responses/200/content/application~1json/examples/errors"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1validation-status/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1validation-status/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/500/content/application~1json/examples/nonNumericId","paths/~1journal-entries~1{jeId}~1validation-status/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/500/content/application~1json/examples/nonNumericId","paths/~1journal-entries~1{jeId}~1validation-status/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1validation-status/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/approval-workflow/getjournalentryvalidationstatus"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/validation-status"}],"content":{"contentType":"group","meta":{"name":"Approval Workflow"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Approval Workflow","showPageActions":true},{"nodeType":"markdoc","content":"Submit, approve, reject, recall, reverse and bulk-delete journal entries; check privileges, audit trail and validation status."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/journal-entries/{jeId}/submit","summary":"Submit a journal entry for approval","prefix":{"name":"post","color":"post"},"badges":[],"link":"/approval-workflow/submitjournalentry","deprecated":false},{"title":"/journal-entries/approve","summary":"Approve journal entries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/approval-workflow/approvejournalentries","deprecated":false},{"title":"/journal-entries/reject","summary":"Reject journal entries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/approval-workflow/rejectjournalentries","deprecated":false},{"title":"/journal-entries/recall","summary":"Recall journal entries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/approval-workflow/recalljournalentries","deprecated":false},{"title":"/journal-entries/reverse","summary":"Reverse a journal entry","prefix":{"name":"post","color":"post"},"badges":[],"link":"/approval-workflow/reversejournalentry","deprecated":false},{"title":"/journal-entries/bulk-delete","summary":"Delete several journal entries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/approval-workflow/bulkdeletejournalentries","deprecated":false},{"title":"/journal-entries/privileges","summary":"Check allowed actions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/approval-workflow/getjournalentryprivileges","deprecated":false},{"title":"/journal-entries/{jeId}/events","summary":"List journal entry audit events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/approval-workflow/listjournalentryevents","deprecated":false},{"title":"/journal-entries/{jeId}/validation-status","summary":"Retrieve the validation status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/approval-workflow/getjournalentryvalidationstatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Reference Data","link":"/other-api/revenue-api-3.0/reference-data","routeSlug":"/other-api/revenue-api-3.0/reference-data","items":[{"label":"Retrieve reference data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/getjournalentrymetadata","routeSlug":"/other-api/revenue-api-3.0/reference-data/getjournalentrymetadata","metadata":{"seo":{"title":"Retrieve reference data","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJournalEntryMetadata","name":"Retrieve reference data","isWebhook":false,"pointer":"/paths/~1journal-entries~1metadata/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve reference data","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the lists of valid values you need to build a journal entry: books, organizations, category codes, exchange rate types, approval and functional currencies, Set of Books names, GL transfer values, accounting methods, account types, accounting segments, VC types and cost types. Call it once and cache the result. Period lists are returned by GET /journal-entries/metadata/periods."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before building entries: get the valid books, organizations, categories, exchange rate types, account types, currencies and other code lists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Populate drop-downs in your own UI, or validate data in your source system before sending it. Cache the result."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/metadata","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/metadata","href":"reference-data/getjournalentrymetadata","openApiOperationId":"getJournalEntryMetadata","summary":"Retrieve reference data"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Reference data","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Metadata","exampleIds":["paths/~1journal-entries~1metadata/get/responses/200/content/application~1json/examples/referenceData"]}},"schemaId":"components/schemas/Metadata","exampleIds":["paths/~1journal-entries~1metadata/get/responses/200/content/application~1json/examples/referenceData"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1metadata/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1metadata/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1metadata/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1metadata/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1metadata/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1metadata/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1metadata/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1metadata/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1metadata/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1metadata/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1metadata/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1metadata/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1metadata/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Metadata","exampleIds":["paths/~1journal-entries~1metadata/get/responses/200/content/application~1json/examples/referenceData"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Metadata","exampleIds":["paths/~1journal-entries~1metadata/get/responses/200/content/application~1json/examples/referenceData"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1metadata/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1metadata/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1metadata/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1metadata/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1metadata/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1metadata/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1metadata/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1metadata/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1metadata/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1metadata/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1metadata/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1metadata/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-data/getjournalentrymetadata"}],"panels":[]}]},"httpPath":"/journal-entries/metadata"},{"label":"List posting and reversal periods","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/getjournalentryperiods","routeSlug":"/other-api/revenue-api-3.0/reference-data/getjournalentryperiods","metadata":{"seo":{"title":"List posting and reversal periods","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJournalEntryPeriods","name":"List posting and reversal periods","isWebhook":false,"pointer":"/paths/~1journal-entries~1metadata~1periods/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List posting and reversal periods","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the posting periods and reversal periods available for a book (and optionally an organization). Use the returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversalPeriodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find which periods are open for posting ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or available for reversal ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversalPeriodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for a book and organization."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"bookId","in":"query","schemaId":"schema_22","description":"Accounting book ID.","required":true,"example":1},{"name":"orgId","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization ID. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supply it"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - omitting it currently causes an error."},"children":[]}]}]}],"example":"101"},{"name":"isJeApproved","in":"query","schemaId":"schema_36","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to get the periods that apply to an approved entry (for example when choosing a reversal period)."},"children":[]}]}]}],"example":false}],"pointer":"/paths/~1journal-entries~1metadata~1periods/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/metadata/periods","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[{"name":"bookId","in":"query","required":true,"example":1,"schemaId":"schema_22"},{"name":"orgId","in":"query","required":false,"example":"101","schemaId":"schema_3"},{"name":"isJeApproved","in":"query","required":false,"example":false,"schemaId":"schema_36"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/metadata/periods","href":"reference-data/getjournalentryperiods","openApiOperationId":"getJournalEntryPeriods","summary":"List posting and reversal periods"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Periods","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Metadata","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/200/content/application~1json/examples/periods"]}},"schemaId":"components/schemas/Metadata","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/200/content/application~1json/examples/periods"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1metadata~1periods/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1metadata~1periods/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"bookId missing; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/500/content/application~1json/examples/bookidMissing","paths/~1journal-entries~1metadata~1periods/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/500/content/application~1json/examples/bookidMissing","paths/~1journal-entries~1metadata~1periods/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1metadata~1periods/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Metadata","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/200/content/application~1json/examples/periods"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Metadata","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/200/content/application~1json/examples/periods"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1metadata~1periods/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1metadata~1periods/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/500/content/application~1json/examples/bookidMissing","paths/~1journal-entries~1metadata~1periods/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/500/content/application~1json/examples/bookidMissing","paths/~1journal-entries~1metadata~1periods/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1metadata~1periods/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-data/getjournalentryperiods"}],"panels":[]}]},"httpPath":"/journal-entries/metadata/periods"},{"label":"Retrieve field configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/getjournalentryconfigurations","routeSlug":"/other-api/revenue-api-3.0/reference-data/getjournalentryconfigurations","metadata":{"seo":{"title":"Retrieve field configuration","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJournalEntryConfigurations","name":"Retrieve field configuration","isWebhook":false,"pointer":"/paths/~1journal-entries~1configurations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve field configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns your tenant's journal entry field configuration, such as the labels assigned to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Learn your tenant's labels for configurable fields (for example what "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means) so you can map your data to the right fields."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/configurations","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/configurations","href":"reference-data/getjournalentryconfigurations","openApiOperationId":"getJournalEntryConfigurations","summary":"Retrieve field configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Field configuration","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Configurations","exampleIds":["paths/~1journal-entries~1configurations/get/responses/200/content/application~1json/examples/fieldConfiguration"]}},"schemaId":"components/schemas/Configurations","exampleIds":["paths/~1journal-entries~1configurations/get/responses/200/content/application~1json/examples/fieldConfiguration"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1configurations/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1configurations/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1configurations/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1configurations/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1configurations/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1configurations/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1configurations/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1configurations/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1configurations/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1configurations/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1configurations/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1configurations/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1configurations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Configurations","exampleIds":["paths/~1journal-entries~1configurations/get/responses/200/content/application~1json/examples/fieldConfiguration"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Configurations","exampleIds":["paths/~1journal-entries~1configurations/get/responses/200/content/application~1json/examples/fieldConfiguration"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1configurations/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1configurations/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1configurations/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1configurations/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1configurations/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1configurations/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1configurations/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1configurations/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1configurations/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1configurations/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1configurations/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1configurations/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-data/getjournalentryconfigurations"}],"panels":[]}]},"httpPath":"/journal-entries/configurations"},{"label":"Retrieve the current open period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/getcurrentopenperiod","routeSlug":"/other-api/revenue-api-3.0/reference-data/getcurrentopenperiod","metadata":{"seo":{"title":"Retrieve the current open period","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCurrentOpenPeriod","name":"Retrieve the current open period","isWebhook":false,"pointer":"/paths/~1journal-entries~1current-period/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the current open period","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the current open accounting period for a book (and optionally an organization). Handy as the default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for new entries."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Default the posting period of a new entry to the current open period."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"bookId","in":"query","schemaId":"schema_22","description":"Accounting book ID.","required":true,"example":1},{"name":"orgId","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization ID. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supply it"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - omitting it currently causes an error."},"children":[]}]}]}],"example":"101"}],"pointer":"/paths/~1journal-entries~1current-period/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/current-period","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[{"name":"bookId","in":"query","required":true,"example":1,"schemaId":"schema_22"},{"name":"orgId","in":"query","required":false,"example":"101","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/current-period","href":"reference-data/getcurrentopenperiod","openApiOperationId":"getCurrentOpenPeriod","summary":"Retrieve the current open period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current open period","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CurrentPeriod","exampleIds":["paths/~1journal-entries~1current-period/get/responses/200/content/application~1json/examples/currentOpenPeriod"]}},"schemaId":"components/schemas/CurrentPeriod","exampleIds":["paths/~1journal-entries~1current-period/get/responses/200/content/application~1json/examples/currentOpenPeriod"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1current-period/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1current-period/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1current-period/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1current-period/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1current-period/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1current-period/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1current-period/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1current-period/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"bookId missing; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1current-period/get/responses/500/content/application~1json/examples/bookidMissing","paths/~1journal-entries~1current-period/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1current-period/get/responses/500/content/application~1json/examples/bookidMissing","paths/~1journal-entries~1current-period/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1current-period/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1current-period/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1current-period/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CurrentPeriod","exampleIds":["paths/~1journal-entries~1current-period/get/responses/200/content/application~1json/examples/currentOpenPeriod"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CurrentPeriod","exampleIds":["paths/~1journal-entries~1current-period/get/responses/200/content/application~1json/examples/currentOpenPeriod"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1current-period/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1current-period/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1current-period/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1current-period/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1current-period/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1current-period/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1current-period/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1current-period/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1current-period/get/responses/500/content/application~1json/examples/bookidMissing","paths/~1journal-entries~1current-period/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1current-period/get/responses/500/content/application~1json/examples/bookidMissing","paths/~1journal-entries~1current-period/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1current-period/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1current-period/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-data/getcurrentopenperiod"}],"panels":[]}]},"httpPath":"/journal-entries/current-period"},{"label":"List transaction currencies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/listjournalentrycurrencies","routeSlug":"/other-api/revenue-api-3.0/reference-data/listjournalentrycurrencies","metadata":{"seo":{"title":"List transaction currencies","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listJournalEntryCurrencies","name":"List transaction currencies","isWebhook":false,"pointer":"/paths/~1journal-entries~1currencies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List transaction currencies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the ISO 4217 currency codes that can be used as a line "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate or offer the transaction currencies that can be used on lines."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/currencies","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/currencies","href":"reference-data/listjournalentrycurrencies","openApiOperationId":"listJournalEntryCurrencies","summary":"List transaction currencies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Currency codes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47","exampleIds":["paths/~1journal-entries~1currencies/get/responses/200/content/application~1json/examples/currencyCodes"]}},"schemaId":"schema_47","exampleIds":["paths/~1journal-entries~1currencies/get/responses/200/content/application~1json/examples/currencyCodes"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1currencies/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1currencies/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1currencies/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1currencies/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1currencies/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1currencies/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1currencies/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1currencies/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1currencies/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1currencies/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1currencies/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1currencies/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1currencies/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_47","exampleIds":["paths/~1journal-entries~1currencies/get/responses/200/content/application~1json/examples/currencyCodes"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47","exampleIds":["paths/~1journal-entries~1currencies/get/responses/200/content/application~1json/examples/currencyCodes"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1currencies/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1currencies/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1currencies/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1currencies/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1currencies/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1currencies/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1currencies/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1currencies/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1currencies/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1currencies/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1currencies/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1currencies/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-data/listjournalentrycurrencies"}],"panels":[]}]},"httpPath":"/journal-entries/currencies"},{"label":"List functional currencies for a Set of Books","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/listfunctionalcurrencies","routeSlug":"/other-api/revenue-api-3.0/reference-data/listfunctionalcurrencies","metadata":{"seo":{"title":"List functional currencies for a Set of Books","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFunctionalCurrencies","name":"List functional currencies for a Set of Books","isWebhook":false,"pointer":"/paths/~1journal-entries~1functional-currencies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List functional currencies for a Set of Books","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the functional currency codes available for a Set of Books. Use it to fill "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"functionalCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the header."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fill or validate the header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"functionalCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a chosen Set of Books."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sobName","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set of Books name (from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sobName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata)."},"children":[]}]}]}],"required":true,"example":"US Primary SOB"}],"pointer":"/paths/~1journal-entries~1functional-currencies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/functional-currencies","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[{"name":"sobName","in":"query","required":true,"example":"US Primary SOB","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/functional-currencies","href":"reference-data/listfunctionalcurrencies","openApiOperationId":"listFunctionalCurrencies","summary":"List functional currencies for a Set of Books"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Functional currencies","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/200/content/application~1json/examples/functionalCurrencies"]}},"schemaId":"schema_47","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/200/content/application~1json/examples/functionalCurrencies"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1functional-currencies/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1functional-currencies/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"sobName missing; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/500/content/application~1json/examples/sobnameMissing","paths/~1journal-entries~1functional-currencies/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/500/content/application~1json/examples/sobnameMissing","paths/~1journal-entries~1functional-currencies/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1functional-currencies/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_47","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/200/content/application~1json/examples/functionalCurrencies"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/200/content/application~1json/examples/functionalCurrencies"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1functional-currencies/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1functional-currencies/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/500/content/application~1json/examples/sobnameMissing","paths/~1journal-entries~1functional-currencies/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/500/content/application~1json/examples/sobnameMissing","paths/~1journal-entries~1functional-currencies/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1functional-currencies/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-data/listfunctionalcurrencies"}],"panels":[]}]},"httpPath":"/journal-entries/functional-currencies"},{"label":"Retrieve debit and credit totals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/getjournalentrysummary","routeSlug":"/other-api/revenue-api-3.0/reference-data/getjournalentrysummary","metadata":{"seo":{"title":"Retrieve debit and credit totals","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJournalEntrySummary","name":"Retrieve debit and credit totals","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1summary/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve debit and credit totals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the total debits, credits and net amount of a journal entry in transaction, functional and reporting currency. A balanced entry has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"netAmt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check that an entry is balanced ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"netAmt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and see its totals before submitting or approving."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Control totals for reconciliation with the source system."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}~1summary/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/{jeId}/summary","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/summary","href":"reference-data/getjournalentrysummary","openApiOperationId":"getJournalEntrySummary","summary":"Retrieve debit and credit totals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Totals by currency type","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_55","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/200/content/application~1json/examples/totalsByCurrencyType"]}},"schemaId":"schema_55","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/200/content/application~1json/examples/totalsByCurrencyType"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1summary/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1summary/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Non-numeric ID; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/500/content/application~1json/examples/nonNumericId","paths/~1journal-entries~1{jeId}~1summary/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/500/content/application~1json/examples/nonNumericId","paths/~1journal-entries~1{jeId}~1summary/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1summary/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_55","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/200/content/application~1json/examples/totalsByCurrencyType"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_55","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/200/content/application~1json/examples/totalsByCurrencyType"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1summary/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1summary/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/500/content/application~1json/examples/nonNumericId","paths/~1journal-entries~1{jeId}~1summary/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/500/content/application~1json/examples/nonNumericId","paths/~1journal-entries~1{jeId}~1summary/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1summary/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-data/getjournalentrysummary"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/summary"},{"label":"Check the soft-freeze status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/checksoftfreeze","routeSlug":"/other-api/revenue-api-3.0/reference-data/checksoftfreeze","metadata":{"seo":{"title":"Check the soft-freeze status","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"checkSoftFreeze","name":"Check the soft-freeze status","isWebhook":false,"pointer":"/paths/~1journal-entries~1soft-freeze-check/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check the soft-freeze status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns, for each book and organization available to the caller, whether a soft freeze is in effect. During a soft freeze (typically during period close) journal entry changes are restricted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before creating or changing entries during period close, to know whether changes are currently restricted for a book and organization."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/soft-freeze-check","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/soft-freeze-check","href":"reference-data/checksoftfreeze","openApiOperationId":"checkSoftFreeze","summary":"Check the soft-freeze status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Soft-freeze state","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/200/content/application~1json/examples/softFreezeState"]}},"schemaId":"schema_56","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/200/content/application~1json/examples/softFreezeState"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1soft-freeze-check/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1soft-freeze-check/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1soft-freeze-check/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_56","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/200/content/application~1json/examples/softFreezeState"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/200/content/application~1json/examples/softFreezeState"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1soft-freeze-check/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1soft-freeze-check/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1soft-freeze-check/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-data/checksoftfreeze"}],"panels":[]}]},"httpPath":"/journal-entries/soft-freeze-check"},{"label":"Retrieve the caller's access level","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/getjournalentryuserrole","routeSlug":"/other-api/revenue-api-3.0/reference-data/getjournalentryuserrole","metadata":{"seo":{"title":"Retrieve the caller's access level","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getJournalEntryUserRole","name":"Retrieve the caller's access level","isWebhook":false,"pointer":"/paths/~1journal-entries~1role/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the caller's access level","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the caller's level of access to manual journal entries: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FULL_ACCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READ_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find out whether the API user (or the user your integration acts for) has full, read-only or no access to manual journal entries."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/role","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/role","href":"reference-data/getjournalentryuserrole","openApiOperationId":"getJournalEntryUserRole","summary":"Retrieve the caller's access level"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Access level","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserRole","exampleIds":["paths/~1journal-entries~1role/get/responses/200/content/application~1json/examples/accessLevel"]}},"schemaId":"components/schemas/UserRole","exampleIds":["paths/~1journal-entries~1role/get/responses/200/content/application~1json/examples/accessLevel"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1role/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1role/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1role/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1role/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1role/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1role/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1role/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1role/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1role/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1role/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1role/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1role/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1role/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserRole","exampleIds":["paths/~1journal-entries~1role/get/responses/200/content/application~1json/examples/accessLevel"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserRole","exampleIds":["paths/~1journal-entries~1role/get/responses/200/content/application~1json/examples/accessLevel"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1role/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1role/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1role/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1role/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1role/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1role/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1role/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1role/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1role/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1role/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1role/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1role/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-data/getjournalentryuserrole"}],"panels":[]}]},"httpPath":"/journal-entries/role"},{"label":"List journal entry object definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/describejournalentryobjects","routeSlug":"/other-api/revenue-api-3.0/reference-data/describejournalentryobjects","metadata":{"seo":{"title":"List journal entry object definitions","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"describeJournalEntryObjects","name":"List journal entry object definitions","isWebhook":false,"pointer":"/paths/~1journal-entries~1describe/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List journal entry object definitions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the column catalog (name, label, data type, order) of the journal entry header ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeHead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), line ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeLine"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and schedule ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") objects, with your tenant's custom labels applied. Use it to build field mappings for integrations or CSV uploads."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Build or maintain a field mapping between your system and Zuora Revenue (header, line and schedule columns), including your tenant's custom labels."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generate your own CSV templates or validation rules."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"object","in":"query","schemaId":"schema_57","description":"Return only one object. Case-insensitive.","example":"jeLine"}],"pointer":"/paths/~1journal-entries~1describe/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/describe","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[{"name":"object","in":"query","required":false,"example":"jeLine","schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500","502"],"pointer":"/journal-entries/describe","href":"reference-data/describejournalentryobjects","openApiOperationId":"describeJournalEntryObjects","summary":"List journal entry object definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Column catalog","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DescribeResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/200/content/application~1json/examples/columnCatalog"]}},"schemaId":"components/schemas/DescribeResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/200/content/application~1json/examples/columnCatalog"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"400","description":"Unknown object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/400/content/application~1json/examples/unknownObject"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/400/content/application~1json/examples/unknownObject"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1describe/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1describe/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1describe/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1describe/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1describe/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1describe/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1describe/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DescribeResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/200/content/application~1json/examples/columnCatalog"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DescribeResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/200/content/application~1json/examples/columnCatalog"]}}},{"code":"400","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/400/content/application~1json/examples/unknownObject"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/400/content/application~1json/examples/unknownObject"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1describe/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1describe/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1describe/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1describe/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1describe/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1describe/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1describe/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-data/describejournalentryobjects"}],"panels":[]}]},"httpPath":"/journal-entries/describe"},{"label":"Retrieve the revenue contract for an RC, sales order, or line","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/reference-data/getrevenuecontractredirection","routeSlug":"/other-api/revenue-api-3.0/reference-data/getrevenuecontractredirection","metadata":{"seo":{"title":"Retrieve the revenue contract for an RC, sales order, or line","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRevenueContractRedirection","name":"Retrieve the revenue contract for an RC, sales order, or line","isWebhook":false,"pointer":"/paths/~1journal-entries~1rc-redirection/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the revenue contract for an RC, sales order, or line","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resolves the revenue contract (RC) that contains a given revenue contract ID, sales order number or line ID, so you can link a journal entry line to its contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You have a sales order number, line ID or RC ID and need the revenue contract to link a journal entry line to ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"type","in":"query","schemaId":"schema_58","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (revenue contract ID), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (sales order number) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LINE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (line ID). Case-insensitive."},"children":[]}]}]}],"required":true,"example":"SO"},{"name":"id","in":"query","schemaId":"schema_3","description":"The identifier to resolve.","required":true,"example":"SO-50012"},{"name":"bookId","in":"query","schemaId":"schema_22","description":"Accounting book ID.","required":true,"example":1}],"pointer":"/paths/~1journal-entries~1rc-redirection/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/rc-redirection","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[{"name":"type","in":"query","required":true,"example":"SO","schemaId":"schema_58"},{"name":"id","in":"query","required":true,"example":"SO-50012","schemaId":"schema_3"},{"name":"bookId","in":"query","required":true,"example":1,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/rc-redirection","href":"reference-data/getrevenuecontractredirection","openApiOperationId":"getRevenueContractRedirection","summary":"Retrieve the revenue contract for an RC, sales order, or line"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Revenue contract found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcRedirection","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/200/content/application~1json/examples/revenueContractFound","paths/~1journal-entries~1rc-redirection/get/responses/200/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/RcRedirection","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/200/content/application~1json/examples/revenueContractFound","paths/~1journal-entries~1rc-redirection/get/responses/200/content/application~1json/examples/notFound"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1rc-redirection/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1rc-redirection/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Invalid type; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/500/content/application~1json/examples/invalidType","paths/~1journal-entries~1rc-redirection/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/500/content/application~1json/examples/invalidType","paths/~1journal-entries~1rc-redirection/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1rc-redirection/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RcRedirection","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/200/content/application~1json/examples/revenueContractFound","paths/~1journal-entries~1rc-redirection/get/responses/200/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RcRedirection","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/200/content/application~1json/examples/revenueContractFound","paths/~1journal-entries~1rc-redirection/get/responses/200/content/application~1json/examples/notFound"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1rc-redirection/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1rc-redirection/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/500/content/application~1json/examples/invalidType","paths/~1journal-entries~1rc-redirection/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/500/content/application~1json/examples/invalidType","paths/~1journal-entries~1rc-redirection/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1rc-redirection/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference-data/getrevenuecontractredirection"}],"panels":[]}]},"httpPath":"/journal-entries/rc-redirection"}],"content":{"contentType":"group","meta":{"name":"Reference Data"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reference Data","showPageActions":true},{"nodeType":"markdoc","content":"Look up the valid values (periods, books, organizations, currencies, account types, categories) and configuration needed to build a journal entry."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/journal-entries/metadata","summary":"Retrieve reference data","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-data/getjournalentrymetadata","deprecated":false},{"title":"/journal-entries/metadata/periods","summary":"List posting and reversal periods","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-data/getjournalentryperiods","deprecated":false},{"title":"/journal-entries/configurations","summary":"Retrieve field configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-data/getjournalentryconfigurations","deprecated":false},{"title":"/journal-entries/current-period","summary":"Retrieve the current open period","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-data/getcurrentopenperiod","deprecated":false},{"title":"/journal-entries/currencies","summary":"List transaction currencies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-data/listjournalentrycurrencies","deprecated":false},{"title":"/journal-entries/functional-currencies","summary":"List functional currencies for a Set of Books","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-data/listfunctionalcurrencies","deprecated":false},{"title":"/journal-entries/{jeId}/summary","summary":"Retrieve debit and credit totals","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-data/getjournalentrysummary","deprecated":false},{"title":"/journal-entries/soft-freeze-check","summary":"Check the soft-freeze status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-data/checksoftfreeze","deprecated":false},{"title":"/journal-entries/role","summary":"Retrieve the caller's access level","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-data/getjournalentryuserrole","deprecated":false},{"title":"/journal-entries/describe","summary":"List journal entry object definitions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-data/describejournalentryobjects","deprecated":false},{"title":"/journal-entries/rc-redirection","summary":"Retrieve the revenue contract for an RC, sales order, or line","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference-data/getrevenuecontractredirection","deprecated":false}]}]}]}]}},{"type":"group","label":"Attachments","link":"/other-api/revenue-api-3.0/attachments","routeSlug":"/other-api/revenue-api-3.0/attachments","items":[{"label":"Upload an attachment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/attachments/uploadjournalentryattachment","routeSlug":"/other-api/revenue-api-3.0/attachments/uploadjournalentryattachment","metadata":{"seo":{"title":"Upload an attachment","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadJournalEntryAttachment","name":"Upload an attachment","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1attachments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload an attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attaches a supporting file (for example a calculation workbook or approval email) to a journal entry, optionally with a note and a link. Files up to 100 MB are accepted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attach supporting evidence (calculation workbook, approval email, contract) or a note/link to an entry, typically before submitting it for approval."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}~1attachments/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"bookId","in":"query","schemaId":"schema_22","description":"Accounting book ID of the journal entry.","required":true,"example":1},{"name":"comments","in":"query","schemaId":"schema_3","description":"Note stored with the attachment.","example":"Supporting calculation"},{"name":"addLink","in":"query","schemaId":"schema_3","description":"Optional URL stored with the attachment.","example":"https://example.com/docs/123"}],"pointer":"/paths/~1journal-entries~1{jeId}~1attachments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/AttachmentUploadRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/requestBody/content/multipart~1form-data/examples/file"]}},"schemaId":"components/schemas/AttachmentUploadRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/requestBody/content/multipart~1form-data/examples/file"],"pointer":"/paths/~1journal-entries~1{jeId}~1attachments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries/{jeId}/attachments","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[{"name":"bookId","in":"query","required":true,"example":1,"schemaId":"schema_22"},{"name":"comments","in":"query","required":false,"example":"Supporting calculation","schemaId":"schema_3"},{"name":"addLink","in":"query","required":false,"example":"https://example.com/docs/123","schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/AttachmentUploadRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/requestBody/content/multipart~1form-data/examples/file"]}},"responseCodes":["200","401","403","413","429","500","502"],"pointer":"/journal-entries/{jeId}/attachments","href":"attachments/uploadjournalentryattachment","openApiOperationId":"uploadJournalEntryAttachment","summary":"Upload an attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/AttachmentUploadRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/requestBody/content/multipart~1form-data/examples/file"],"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/AttachmentUploadRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/requestBody/content/multipart~1form-data/examples/file"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment uploaded","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AttachmentUploadResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/200/content/application~1json/examples/attachmentUploaded"]}},"schemaId":"components/schemas/AttachmentUploadResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/200/content/application~1json/examples/attachmentUploaded"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1attachments/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1attachments/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"413","description":"File too large","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/413/content/application~1json/examples/fileTooLarge"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/413/content/application~1json/examples/fileTooLarge"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"File part or bookId missing; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/500/content/application~1json/examples/filePartOrBookidMissing","paths/~1journal-entries~1{jeId}~1attachments/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/500/content/application~1json/examples/filePartOrBookidMissing","paths/~1journal-entries~1{jeId}~1attachments/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Executable file rejected; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/502/content/application~1json/examples/executableFileRejected","paths/~1journal-entries~1{jeId}~1attachments/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/502/content/application~1json/examples/executableFileRejected","paths/~1journal-entries~1{jeId}~1attachments/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1attachments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AttachmentUploadResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/200/content/application~1json/examples/attachmentUploaded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AttachmentUploadResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/200/content/application~1json/examples/attachmentUploaded"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1attachments/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1attachments/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"413","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/413/content/application~1json/examples/fileTooLarge"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/413/content/application~1json/examples/fileTooLarge"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/500/content/application~1json/examples/filePartOrBookidMissing","paths/~1journal-entries~1{jeId}~1attachments/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/500/content/application~1json/examples/filePartOrBookidMissing","paths/~1journal-entries~1{jeId}~1attachments/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/502/content/application~1json/examples/executableFileRejected","paths/~1journal-entries~1{jeId}~1attachments/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/post/responses/502/content/application~1json/examples/executableFileRejected","paths/~1journal-entries~1{jeId}~1attachments/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attachments/uploadjournalentryattachment"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/attachments"},{"label":"List journal entry attachments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/attachments/listjournalentryattachments","routeSlug":"/other-api/revenue-api-3.0/attachments/listjournalentryattachments","metadata":{"seo":{"title":"List journal entry attachments","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listJournalEntryAttachments","name":"List journal entry attachments","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1attachments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List journal entry attachments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the files and notes attached to a journal entry."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See which supporting documents and notes an entry has, for example during approval or audit."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}~1attachments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"bookId","in":"query","schemaId":"schema_22","description":"Accounting book ID of the journal entry.","required":true,"example":1}],"pointer":"/paths/~1journal-entries~1{jeId}~1attachments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/{jeId}/attachments","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[{"name":"bookId","in":"query","required":true,"example":1,"schemaId":"schema_22"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/attachments","href":"attachments/listjournalentryattachments","openApiOperationId":"listJournalEntryAttachments","summary":"List journal entry attachments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachments (may be empty)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/200/content/application~1json/examples/attachmentsMayBeEmpty","paths/~1journal-entries~1{jeId}~1attachments/get/responses/200/content/application~1json/examples/none"]}},"schemaId":"schema_59","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/200/content/application~1json/examples/attachmentsMayBeEmpty","paths/~1journal-entries~1{jeId}~1attachments/get/responses/200/content/application~1json/examples/none"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1attachments/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1attachments/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"bookId missing; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/500/content/application~1json/examples/bookidMissing","paths/~1journal-entries~1{jeId}~1attachments/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/500/content/application~1json/examples/bookidMissing","paths/~1journal-entries~1{jeId}~1attachments/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1attachments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_59","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/200/content/application~1json/examples/attachmentsMayBeEmpty","paths/~1journal-entries~1{jeId}~1attachments/get/responses/200/content/application~1json/examples/none"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/200/content/application~1json/examples/attachmentsMayBeEmpty","paths/~1journal-entries~1{jeId}~1attachments/get/responses/200/content/application~1json/examples/none"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1attachments/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1attachments/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/500/content/application~1json/examples/bookidMissing","paths/~1journal-entries~1{jeId}~1attachments/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/500/content/application~1json/examples/bookidMissing","paths/~1journal-entries~1{jeId}~1attachments/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attachments/listjournalentryattachments"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/attachments"},{"label":"Delete an attachment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/attachments/deletejournalentryattachment","routeSlug":"/other-api/revenue-api-3.0/attachments/deletejournalentryattachment","metadata":{"seo":{"title":"Delete an attachment","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteJournalEntryAttachment","name":"Delete an attachment","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an attachment from a journal entry."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove an attachment that was added by mistake or replaced by a newer version."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The attachment is identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachmentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" alone. Make sure it belongs to the entry in the path."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045},{"name":"attachmentId","in":"path","schemaId":"schema_30","description":"ID of the attachment.","required":true,"example":501}],"pointer":"/paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/journal-entries/{jeId}/attachments/{attachmentId}","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"},{"name":"attachmentId","in":"path","required":true,"example":501,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["204","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/attachments/{attachmentId}","href":"attachments/deletejournalentryattachment","openApiOperationId":"deleteJournalEntryAttachment","summary":"Delete an attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Attachment deleted (no response body)","headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Invalid attachment ID; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/502/content/application~1json/examples/invalidAttachmentId","paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/502/content/application~1json/examples/invalidAttachmentId","paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/502/content/application~1json/examples/invalidAttachmentId","paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/502/content/application~1json/examples/invalidAttachmentId","paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attachments/deletejournalentryattachment"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/attachments/{attachmentId}"},{"label":"Download an attachment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/attachments/downloadjournalentryattachment","routeSlug":"/other-api/revenue-api-3.0/attachments/downloadjournalentryattachment","metadata":{"seo":{"title":"Download an attachment","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadJournalEntryAttachment","name":"Download an attachment","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download an attachment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Downloads an attachment. For files stored in cloud storage the response is JSON with a short-lived presigned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - fetch the file from that URL with a plain GET (no Authorization header). Older attachments are streamed directly as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/octet-stream"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a supporting document for review, audit or archiving."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045},{"name":"attachmentId","in":"path","schemaId":"schema_30","description":"ID of the attachment.","required":true,"example":501}],"pointer":"/paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/{jeId}/attachments/{attachmentId}/download","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"},{"name":"attachmentId","in":"path","required":true,"example":501,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/attachments/{attachmentId}/download","href":"attachments/downloadjournalentryattachment","openApiOperationId":"downloadJournalEntryAttachment","summary":"Download an attachment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Presigned download URL (cloud-stored files)","mediaType":"application/json","mediaTypes":["application/json","application/octet-stream"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AttachmentDownloadUrl","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/200/content/application~1json/examples/presignedDownloadUrlCloudStoredFiles"]},"application/octet-stream":{"schemaId":"schema_33"}},"schemaId":"components/schemas/AttachmentDownloadUrl","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/200/content/application~1json/examples/presignedDownloadUrlCloudStoredFiles"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"File not found; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/502/content/application~1json/examples/fileNotFound","paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/502/content/application~1json/examples/fileNotFound","paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AttachmentDownloadUrl","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/200/content/application~1json/examples/presignedDownloadUrlCloudStoredFiles"],"mediaTypes":["application/json","application/octet-stream"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AttachmentDownloadUrl","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/200/content/application~1json/examples/presignedDownloadUrlCloudStoredFiles"]},"application/octet-stream":{"schemaId":"schema_33"}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/502/content/application~1json/examples/fileNotFound","paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/502/content/application~1json/examples/fileNotFound","paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attachments/downloadjournalentryattachment"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/attachments/{attachmentId}/download"}],"content":{"contentType":"group","meta":{"name":"Attachments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attachments","showPageActions":true},{"nodeType":"markdoc","content":"Attach supporting files and notes to a journal entry, list, download and delete them."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/journal-entries/{jeId}/attachments","summary":"Upload an attachment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/attachments/uploadjournalentryattachment","deprecated":false},{"title":"/journal-entries/{jeId}/attachments","summary":"List journal entry attachments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/attachments/listjournalentryattachments","deprecated":false},{"title":"/journal-entries/{jeId}/attachments/{attachmentId}","summary":"Delete an attachment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/attachments/deletejournalentryattachment","deprecated":false},{"title":"/journal-entries/{jeId}/attachments/{attachmentId}/download","summary":"Download an attachment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/attachments/downloadjournalentryattachment","deprecated":false}]}]}]}]}},{"type":"group","label":"Templates and Exports","link":"/other-api/revenue-api-3.0/templates-and-exports","routeSlug":"/other-api/revenue-api-3.0/templates-and-exports","items":[{"label":"Download the CSV upload template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/templates-and-exports/downloadjournalentrytemplate","routeSlug":"/other-api/revenue-api-3.0/templates-and-exports/downloadjournalentrytemplate","metadata":{"seo":{"title":"Download the CSV upload template","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadJournalEntryTemplate","name":"Download the CSV upload template","isWebhook":false,"pointer":"/paths/~1journal-entries~1template/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download the CSV upload template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Downloads the combined CSV template for POST /journal-entries (multipart). Row 1 holds the header column titles; fill row 2 with the header values, keep the blank line, then add one row per line under the line column titles. Column titles are matched case-insensitively ignoring spaces and punctuation; both friendly titles (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Account Code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Debit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and legacy codes (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DR_SEGMENTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") are accepted. Reference columns show your tenant's labels; rename them to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reference1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ... "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reference15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before uploading."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before preparing a CSV upload: get the exact column layout expected by POST /journal-entries (multipart)."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/journal-entries/template","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/template","href":"templates-and-exports/downloadjournalentrytemplate","openApiOperationId":"downloadJournalEntryTemplate","summary":"Download the CSV upload template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV template ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"je-template.csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"mediaType":"text/csv","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1template/get/responses/200/content/text~1csv/example"]}},"schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1template/get/responses/200/content/text~1csv/example"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"},"Content-Disposition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attachment file name, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment; filename=\"je-list.csv\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string"}}},"headerSchemaId":"schema_60"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1template/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1template/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1template/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1template/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1template/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1template/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1template/get/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1template/get/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1template/get/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1template/get/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1template/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1template/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1template/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1template/get/responses/200/content/text~1csv/example"],"mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1template/get/responses/200/content/text~1csv/example"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1template/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1template/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1template/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1template/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1template/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1template/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1template/get/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1template/get/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1template/get/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1template/get/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1template/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1template/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates-and-exports/downloadjournalentrytemplate"}],"panels":[]}]},"httpPath":"/journal-entries/template"},{"label":"Export journal entries to CSV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/templates-and-exports/exportjournalentries","routeSlug":"/other-api/revenue-api-3.0/templates-and-exports/exportjournalentries","metadata":{"seo":{"title":"Export journal entries to CSV","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"exportJournalEntries","name":"Export journal entries to CSV","isWebhook":false,"pointer":"/paths/~1journal-entries~1export/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export journal entries to CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exports journal entries matching the body criteria as CSV."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Produce a CSV list of entries for reporting, audit or reconciliation in a spreadsheet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body filter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values are passed through as-is and must be one of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversalStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"categoryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exRateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversalPeriodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hashTotal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sobName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"functionalCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approverName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exports return "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matching rows; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must contain at least one element for every operator."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1export/post/requestBody/content/application~1json/examples/all"]}},"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1export/post/requestBody/content/application~1json/examples/all"],"pointer":"/paths/~1journal-entries~1export/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries/export","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1export/post/requestBody/content/application~1json/examples/all"]}},"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/export","href":"templates-and-exports/exportjournalentries","openApiOperationId":"exportJournalEntries","summary":"Export journal entries to CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1export/post/requestBody/content/application~1json/examples/all"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1export/post/requestBody/content/application~1json/examples/all"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"je-list.csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"mediaType":"text/csv","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1export/post/responses/200/content/text~1csv/example"]}},"schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1export/post/responses/200/content/text~1csv/example"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"},"Content-Disposition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attachment file name, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment; filename=\"je-list.csv\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string"}}},"headerSchemaId":"schema_60"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1export/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1export/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Missing body; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1export/post/responses/500/content/application~1json/examples/missingBody","paths/~1journal-entries~1export/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1export/post/responses/500/content/application~1json/examples/missingBody","paths/~1journal-entries~1export/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Invalid filter; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1export/post/responses/502/content/application~1json/examples/invalidFilter","paths/~1journal-entries~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1export/post/responses/502/content/application~1json/examples/invalidFilter","paths/~1journal-entries~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1export/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1export/post/responses/200/content/text~1csv/example"],"mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1export/post/responses/200/content/text~1csv/example"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1export/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1export/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1export/post/responses/500/content/application~1json/examples/missingBody","paths/~1journal-entries~1export/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1export/post/responses/500/content/application~1json/examples/missingBody","paths/~1journal-entries~1export/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1export/post/responses/502/content/application~1json/examples/invalidFilter","paths/~1journal-entries~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1export/post/responses/502/content/application~1json/examples/invalidFilter","paths/~1journal-entries~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates-and-exports/exportjournalentries"}],"panels":[]}]},"httpPath":"/journal-entries/export"},{"label":"Export lines to CSV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/templates-and-exports/exportjournalentrylines","routeSlug":"/other-api/revenue-api-3.0/templates-and-exports/exportjournalentrylines","metadata":{"seo":{"title":"Export lines to CSV","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"exportJournalEntryLines","name":"Export lines to CSV","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1lines~1export/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export lines to CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exports the lines of a journal entry as CSV using the template column titles plus audit columns. The export has no line "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column; to use it for a full-file update (PATCH /journal-entries/{jeId}), add an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column first."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download all lines of an entry to review or reconcile them in a spreadsheet."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body filter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values are passed through as-is and must be one of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"headerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updatedDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bookId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcLineId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"debit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"credit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRateDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gexchangeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errorMessage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"comments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soLineId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soNum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"costOrVcType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeSetNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"typeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference8"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference11"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference12"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference13"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exports return "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matching rows; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must contain at least one element for every operator."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}~1lines~1export/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/requestBody/content/application~1json/examples/all"]}},"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/requestBody/content/application~1json/examples/all"],"pointer":"/paths/~1journal-entries~1{jeId}~1lines~1export/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries/{jeId}/lines/export","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/requestBody/content/application~1json/examples/all"]}},"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/lines/export","href":"templates-and-exports/exportjournalentrylines","openApiOperationId":"exportJournalEntryLines","summary":"Export lines to CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/requestBody/content/application~1json/examples/all"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/requestBody/content/application~1json/examples/all"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"je-lines-{jeId}.csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"mediaType":"text/csv","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/200/content/text~1csv/example"]}},"schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/200/content/text~1csv/example"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"},"Content-Disposition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attachment file name, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment; filename=\"je-list.csv\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string"}}},"headerSchemaId":"schema_60"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Missing body; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/500/content/application~1json/examples/missingBody","paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/500/content/application~1json/examples/missingBody","paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Invalid filter; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/502/content/application~1json/examples/invalidFilter","paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/502/content/application~1json/examples/invalidFilter","paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1lines~1export/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/200/content/text~1csv/example"],"mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/200/content/text~1csv/example"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/500/content/application~1json/examples/missingBody","paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/500/content/application~1json/examples/missingBody","paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/502/content/application~1json/examples/invalidFilter","paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/502/content/application~1json/examples/invalidFilter","paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates-and-exports/exportjournalentrylines"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/lines/export"},{"label":"Export schedules to CSV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/templates-and-exports/exportjournalentryschedules","routeSlug":"/other-api/revenue-api-3.0/templates-and-exports/exportjournalentryschedules","metadata":{"seo":{"title":"Export schedules to CSV","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"exportJournalEntrySchedules","name":"Export schedules to CSV","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1schedules~1export/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export schedules to CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exports the revenue schedules generated by a journal entry as CSV."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download the schedules of an entry for GL reconciliation or audit."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body filter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values are passed through as-is and must be one of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"acountCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencyCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"crAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funcDrAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funcCrAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcurrDrAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcurrCrAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schdRcId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exports return "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matching rows; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must contain at least one element for every operator."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}~1schedules~1export/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/requestBody/content/application~1json/examples/all"]}},"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/requestBody/content/application~1json/examples/all"],"pointer":"/paths/~1journal-entries~1{jeId}~1schedules~1export/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries/{jeId}/schedules/export","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/requestBody/content/application~1json/examples/all"]}},"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/schedules/export","href":"templates-and-exports/exportjournalentryschedules","openApiOperationId":"exportJournalEntrySchedules","summary":"Export schedules to CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/requestBody/content/application~1json/examples/all"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/requestBody/content/application~1json/examples/all"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"je-schedules-{jeId}.csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"mediaType":"text/csv","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/200/content/text~1csv/example"]}},"schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/200/content/text~1csv/example"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"},"Content-Disposition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attachment file name, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment; filename=\"je-list.csv\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string"}}},"headerSchemaId":"schema_60"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Missing body; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/500/content/application~1json/examples/missingBody","paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/500/content/application~1json/examples/missingBody","paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Invalid filter; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/502/content/application~1json/examples/invalidFilter","paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/502/content/application~1json/examples/invalidFilter","paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/200/content/text~1csv/example"],"mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/200/content/text~1csv/example"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/500/content/application~1json/examples/missingBody","paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/500/content/application~1json/examples/missingBody","paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/502/content/application~1json/examples/invalidFilter","paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/502/content/application~1json/examples/invalidFilter","paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates-and-exports/exportjournalentryschedules"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/schedules/export"},{"label":"Export waterfall to CSV","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/templates-and-exports/exportjournalentrywaterfall","routeSlug":"/other-api/revenue-api-3.0/templates-and-exports/exportjournalentrywaterfall","metadata":{"seo":{"title":"Export waterfall to CSV","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"exportJournalEntryWaterfall","name":"Export waterfall to CSV","isWebhook":false,"pointer":"/paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export waterfall to CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exports the revenue waterfall of a journal entry as CSV (one column per period)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Download the revenue waterfall of an entry (one column per period) for analysis or sharing with stakeholders."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body filter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values are passed through as-is and must be one of: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeSetNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"soLineId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exports return "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matching rows; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must contain at least one element for every operator."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OneIdOAuth","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jeId","in":"path","schemaId":"schema_30","description":"ID of the journal entry.","required":true,"example":10045}],"pointer":"/paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/requestBody/content/application~1json/examples/all"]}},"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/requestBody/content/application~1json/examples/all"],"pointer":"/paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/journal-entries/{jeId}/waterfall-entries/export","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"parameters":{"path":[{"name":"jeId","in":"path","required":true,"example":10045,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OneIdOAuth","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/requestBody/content/application~1json/examples/all"]}},"responseCodes":["200","401","403","429","500","502"],"pointer":"/journal-entries/{jeId}/waterfall-entries/export","href":"templates-and-exports/exportjournalentrywaterfall","openApiOperationId":"exportJournalEntryWaterfall","summary":"Export waterfall to CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Zuora Revenue API (base URL)"}],"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/requestBody/content/application~1json/examples/all"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryRequest","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/requestBody/content/application~1json/examples/all"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV file ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"je-waterfall-{jeId}.csv"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"mediaType":"text/csv","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/200/content/text~1csv/example"]}},"schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/200/content/text~1csv/example"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"},"Content-Disposition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attachment file name, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment; filename=\"je-list.csv\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string"}}},"headerSchemaId":"schema_60"},{"code":"401","description":"Missing or expired access token","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]},{"code":"403","description":"Manual Journal Entry APIs not enabled; Role lacks Manual Journal access","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}},"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too many requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/429/content/application~1json/examples/tooManyRequests"]}},"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/429/content/application~1json/examples/tooManyRequests"]},{"code":"500","description":"Missing body; Unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/500/content/application~1json/examples/missingBody","paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/500/content/application~1json/examples/unexpectedError"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/500/content/application~1json/examples/missingBody","paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/500/content/application~1json/examples/unexpectedError"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"},{"code":"502","description":"Invalid filter; Journal entry service unavailable","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/502/content/application~1json/examples/invalidFilter","paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}},"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/502/content/application~1json/examples/invalidFilter","paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"headers":{"traceId":{"$ref":"#/components/headers/traceId"}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/200/content/text~1csv/example"],"mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_3","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/200/content/text~1csv/example"]}}},{"code":"401","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"]}}},{"code":"403","schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PlatformErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled","paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"]}}},{"code":"429","schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/429/content/application~1json/examples/tooManyRequests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MjeGatewayError","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/429/content/application~1json/examples/tooManyRequests"]}}},{"code":"500","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/500/content/application~1json/examples/missingBody","paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/500/content/application~1json/examples/unexpectedError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/500/content/application~1json/examples/missingBody","paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/500/content/application~1json/examples/unexpectedError"]}}},{"code":"502","schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/502/content/application~1json/examples/invalidFilter","paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResponse","exampleIds":["paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/502/content/application~1json/examples/invalidFilter","paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates-and-exports/exportjournalentrywaterfall"}],"panels":[]}]},"httpPath":"/journal-entries/{jeId}/waterfall-entries/export"}],"content":{"contentType":"group","meta":{"name":"Templates and Exports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Templates and Exports","showPageActions":true},{"nodeType":"markdoc","content":"Download the CSV upload template and export entries, lines, schedules and waterfall entries as CSV."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/journal-entries/template","summary":"Download the CSV upload template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates-and-exports/downloadjournalentrytemplate","deprecated":false},{"title":"/journal-entries/export","summary":"Export journal entries to CSV","prefix":{"name":"post","color":"post"},"badges":[],"link":"/templates-and-exports/exportjournalentries","deprecated":false},{"title":"/journal-entries/{jeId}/lines/export","summary":"Export lines to CSV","prefix":{"name":"post","color":"post"},"badges":[],"link":"/templates-and-exports/exportjournalentrylines","deprecated":false},{"title":"/journal-entries/{jeId}/schedules/export","summary":"Export schedules to CSV","prefix":{"name":"post","color":"post"},"badges":[],"link":"/templates-and-exports/exportjournalentryschedules","deprecated":false},{"title":"/journal-entries/{jeId}/waterfall-entries/export","summary":"Export waterfall to CSV","prefix":{"name":"post","color":"post"},"badges":[],"link":"/templates-and-exports/exportjournalentrywaterfall","deprecated":false}]}]}]}]}},{"type":"separator","label":"Revenue Contract Management and Workbench Operations","content":null},{"type":"group","label":"Revenue Contracts","link":"/other-api/revenue-api-3.0/revenue-contracts","routeSlug":"/other-api/revenue-api-3.0/revenue-contracts","items":[{"label":"List revenue contracts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-contracts/listrevenuecontracts","routeSlug":"/other-api/revenue-api-3.0/revenue-contracts/listrevenuecontracts","metadata":{"seo":{"title":"List revenue contracts","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRevenueContracts","name":"List revenue contracts","isWebhook":false,"pointer":"/paths/~1contracts~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List revenue contracts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of revenue contract header records for the book."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Build a contract inventory or reconcile Zuora Revenue contracts with an external system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Look up contract IDs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") before you call the line, hold, or Manual Action APIs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"indicators"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and amounts across many contracts in one pass."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The only filterable and sortable field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every query parameter other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is treated as a filter."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field=value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches records where the field equals the value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field[op]=value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applies an operator. URL-encode the brackets as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%5B"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%5D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for example"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id%5Bgt%5D=1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"like"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (supply "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" wildcards yourself)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All filters are combined with AND. At most 5 filters are allowed per request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blank filter values are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unknown field or operator returns HTTP 400."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_61","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page number, starting at 1. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an omitted value both return the first page."},"children":[]}]}]}],"example":1},{"name":"size","in":"query","schemaId":"schema_62","description":"Records per page. Default 20, maximum 100.","example":20},{"name":"sort","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field,direction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Separate several sort fields with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id,desc;rcId,asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Direction is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; any other value sorts ascending. Sortable fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted the order is not guaranteed, so always sort when paging through results."},"children":[]}]}]}],"example":"id,asc"},{"name":"id","in":"query","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by revenue contract ID. Supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id[op]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" forms such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id[gte]=100000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":111442}],"pointer":"/paths/~1contracts~1list/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1contracts~1list/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contracts/list","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_61"},{"name":"size","in":"query","required":false,"example":20,"schemaId":"schema_62"},{"name":"sort","in":"query","required":false,"example":"id,asc","schemaId":"schema_3"},{"name":"id","in":"query","required":false,"example":111442,"schemaId":"schema_30"}],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/contracts/list","href":"revenue-contracts/listrevenuecontracts","openApiOperationId":"listRevenueContracts","summary":"List revenue contracts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page of records. An empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array means no record matched."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueContractHeadPage","exampleIds":["paths/~1contracts~1list/get/responses/200/content/application~1json/examples/firstPage","paths/~1contracts~1list/get/responses/200/content/application~1json/examples/empty"]}},"schemaId":"components/schemas/RevenueContractHeadPage","exampleIds":["paths/~1contracts~1list/get/responses/200/content/application~1json/examples/firstPage","paths/~1contracts~1list/get/responses/200/content/application~1json/examples/empty"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":"The request is invalid. Correct the request and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unknownSort","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/negativePage","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/invalidPage","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unsupportedOperator"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unknownSort","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/negativePage","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/invalidPage","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unsupportedOperator"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue, such as a database error or a non-numeric value supplied for a numeric filter. Retry later; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1list/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1list/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1contracts~1list/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RevenueContractHeadPage","exampleIds":["paths/~1contracts~1list/get/responses/200/content/application~1json/examples/firstPage","paths/~1contracts~1list/get/responses/200/content/application~1json/examples/empty"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueContractHeadPage","exampleIds":["paths/~1contracts~1list/get/responses/200/content/application~1json/examples/firstPage","paths/~1contracts~1list/get/responses/200/content/application~1json/examples/empty"]}}},{"code":"400","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unknownSort","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/negativePage","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/invalidPage","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unsupportedOperator"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unknownSort","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/negativePage","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/invalidPage","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unsupportedOperator"]}}},{"code":"500","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1list/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1list/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-contracts/listrevenuecontracts"}],"panels":[]}]},"httpPath":"/contracts/list"},{"label":"Retrieve a revenue contract","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-contracts/getrevenuecontract","routeSlug":"/other-api/revenue-api-3.0/revenue-contracts/getrevenuecontract","metadata":{"seo":{"title":"Retrieve a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRevenueContract","name":"Retrieve a revenue contract","isWebhook":false,"pointer":"/paths/~1contracts~1{rcId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the header record of one revenue contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read the current state, indicators, and amounts of a contract before you perform a manual action."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirm that a contract exists in the book you are working in."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1contracts~1{rcId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1contracts~1{rcId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contracts/{rcId}","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/contracts/{rcId}","href":"revenue-contracts/getrevenuecontract","openApiOperationId":"getRevenueContract","summary":"Retrieve a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The revenue contract header.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueContractHead","exampleIds":["paths/~1contracts~1{rcId}/get/responses/200/content/application~1json/examples/contract"]}},"schemaId":"components/schemas/RevenueContractHead","exampleIds":["paths/~1contracts~1{rcId}/get/responses/200/content/application~1json/examples/contract"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":"The request is invalid. Correct the request and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}/get/responses/400/content/application~1json/examples/invalidRcId"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}/get/responses/400/content/application~1json/examples/invalidRcId"]},{"code":"404","description":"The revenue contract does not exist in this tenant and book, or the caller's organization cannot see it.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}/get/responses/404/content/application~1json/examples/notFound"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue, such as a database error or a non-numeric value supplied for a numeric filter. Retry later; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1contracts~1{rcId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RevenueContractHead","exampleIds":["paths/~1contracts~1{rcId}/get/responses/200/content/application~1json/examples/contract"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueContractHead","exampleIds":["paths/~1contracts~1{rcId}/get/responses/200/content/application~1json/examples/contract"]}}},{"code":"400","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}/get/responses/400/content/application~1json/examples/invalidRcId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}/get/responses/400/content/application~1json/examples/invalidRcId"]}}},{"code":"404","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}/get/responses/404/content/application~1json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-contracts/getrevenuecontract"}],"panels":[]}]},"httpPath":"/contracts/{rcId}"}],"content":{"contentType":"group","meta":{"name":"Revenue Contracts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revenue Contracts","showPageActions":true},{"nodeType":"markdoc","content":"Look up revenue contract header records."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/contracts/list","summary":"List revenue contracts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-contracts/listrevenuecontracts","deprecated":false},{"title":"/contracts/{rcId}","summary":"Retrieve a revenue contract","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-contracts/getrevenuecontract","deprecated":false}]}]}]}]}},{"type":"group","label":"Revenue Contract Lines","link":"/other-api/revenue-api-3.0/revenue-contract-lines","routeSlug":"/other-api/revenue-api-3.0/revenue-contract-lines","items":[{"label":"List lines of a revenue contract","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-contract-lines/listrevenuecontractlines","routeSlug":"/other-api/revenue-api-3.0/revenue-contract-lines/listrevenuecontractlines","metadata":{"seo":{"title":"List lines of a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRevenueContractLines","name":"List lines of a revenue contract","isWebhook":false,"pointer":"/paths/~1contracts~1{rcId}~1lines/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List lines of a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of the transaction lines grouped into one revenue contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Review the sales order, contract, and invoice lines that make up a contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find line IDs, POB IDs, and charge numbers to use in Manual Action calls such as edit line, line-level holds, or variable consideration."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A contract that does not exist returns HTTP 200 with an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array, not HTTP 404."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every query parameter other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is treated as a filter."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field=value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches records where the field equals the value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field[op]=value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applies an operator. URL-encode the brackets as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%5B"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%5D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for example"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id%5Bgt%5D=1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"like"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (supply "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" wildcards yourself)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All filters are combined with AND. At most 5 filters are allowed per request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blank filter values are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unknown field or operator returns HTTP 400."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1contracts~1{rcId}~1lines/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_61","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page number, starting at 1. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an omitted value both return the first page."},"children":[]}]}]}],"example":1},{"name":"size","in":"query","schemaId":"schema_62","description":"Records per page. Default 20, maximum 100.","example":20},{"name":"sort","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field,direction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Separate several sort fields with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id,desc;rcId,asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Direction is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; any other value sorts ascending. Sortable fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcPobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted the order is not guaranteed, so always sort when paging through results."},"children":[]}]}]}],"example":"id,asc"},{"name":"id","in":"query","schemaId":"schema_30","description":"Filter by revenue contract line ID.","example":85922},{"name":"rcPobId","in":"query","schemaId":"schema_30","description":"Filter by performance obligation (POB) ID.","example":156912},{"name":"batchId","in":"query","schemaId":"schema_30","description":"Filter by the data-collection batch that created the line.","example":5001},{"name":"chargeNumber","in":"query","schemaId":"schema_3","description":"Filter by Zuora Billing rate plan charge number.","example":"C-00012345"}],"pointer":"/paths/~1contracts~1{rcId}~1lines/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1contracts~1{rcId}~1lines/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contracts/{rcId}/lines","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_61"},{"name":"size","in":"query","required":false,"example":20,"schemaId":"schema_62"},{"name":"sort","in":"query","required":false,"example":"id,asc","schemaId":"schema_3"},{"name":"id","in":"query","required":false,"example":85922,"schemaId":"schema_30"},{"name":"rcPobId","in":"query","required":false,"example":156912,"schemaId":"schema_30"},{"name":"batchId","in":"query","required":false,"example":5001,"schemaId":"schema_30"},{"name":"chargeNumber","in":"query","required":false,"example":"C-00012345","schemaId":"schema_3"}],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/contracts/{rcId}/lines","href":"revenue-contract-lines/listrevenuecontractlines","openApiOperationId":"listRevenueContractLines","summary":"List lines of a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page of records. An empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array means no record matched."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueContractLinePage","exampleIds":["paths/~1contracts~1{rcId}~1lines/get/responses/200/content/application~1json/examples/firstPage","paths/~1contracts~1{rcId}~1lines/get/responses/200/content/application~1json/examples/empty"]}},"schemaId":"components/schemas/RevenueContractLinePage","exampleIds":["paths/~1contracts~1{rcId}~1lines/get/responses/200/content/application~1json/examples/firstPage","paths/~1contracts~1{rcId}~1lines/get/responses/200/content/application~1json/examples/empty"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":"The request is invalid. Correct the request and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unknownSort","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/invalidRcId","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/negativePage","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/invalidPage","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unsupportedOperator"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unknownSort","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/invalidRcId","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/negativePage","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/invalidPage","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unsupportedOperator"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue, such as a database error or a non-numeric value supplied for a numeric filter. Retry later; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1contracts~1{rcId}~1lines/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RevenueContractLinePage","exampleIds":["paths/~1contracts~1{rcId}~1lines/get/responses/200/content/application~1json/examples/firstPage","paths/~1contracts~1{rcId}~1lines/get/responses/200/content/application~1json/examples/empty"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueContractLinePage","exampleIds":["paths/~1contracts~1{rcId}~1lines/get/responses/200/content/application~1json/examples/firstPage","paths/~1contracts~1{rcId}~1lines/get/responses/200/content/application~1json/examples/empty"]}}},{"code":"400","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unknownSort","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/invalidRcId","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/negativePage","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/invalidPage","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unsupportedOperator"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unknownSort","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/invalidRcId","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/negativePage","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/invalidPage","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unsupportedOperator"]}}},{"code":"500","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-contract-lines/listrevenuecontractlines"}],"panels":[]}]},"httpPath":"/contracts/{rcId}/lines"},{"label":"Retrieve a revenue contract line","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-contract-lines/getrevenuecontractline","routeSlug":"/other-api/revenue-api-3.0/revenue-contract-lines/getrevenuecontractline","metadata":{"seo":{"title":"Retrieve a revenue contract line","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRevenueContractLine","name":"Retrieve a revenue contract line","isWebhook":false,"pointer":"/paths/~1contracts~1{rcId}~1lines~1{lineId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a revenue contract line","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns one line of a revenue contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read the attributes of a specific line before or after you edit it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify that a line belongs to the contract you expect."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A line that exists but belongs to a different contract returns HTTP 404."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442},{"name":"lineId","in":"path","schemaId":"schema_30","description":"Revenue contract line ID.","required":true,"example":85922}],"pointer":"/paths/~1contracts~1{rcId}~1lines~1{lineId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1contracts~1{rcId}~1lines~1{lineId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contracts/{rcId}/lines/{lineId}","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"},{"name":"lineId","in":"path","required":true,"example":85922,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/contracts/{rcId}/lines/{lineId}","href":"revenue-contract-lines/getrevenuecontractline","openApiOperationId":"getRevenueContractLine","summary":"Retrieve a revenue contract line"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The revenue contract line.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueContractLine","exampleIds":["paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/200/content/application~1json/examples/line"]}},"schemaId":"components/schemas/RevenueContractLine","exampleIds":["paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/200/content/application~1json/examples/line"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":"The request is invalid. Correct the request and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/400/content/application~1json/examples/invalidRcId","paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/400/content/application~1json/examples/invalidLineId"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/400/content/application~1json/examples/invalidRcId","paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/400/content/application~1json/examples/invalidLineId"]},{"code":"404","description":"The revenue contract line does not exist in this tenant and book, or the caller's organization cannot see it.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/404/content/application~1json/examples/notFound"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue, such as a database error or a non-numeric value supplied for a numeric filter. Retry later; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RevenueContractLine","exampleIds":["paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/200/content/application~1json/examples/line"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueContractLine","exampleIds":["paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/200/content/application~1json/examples/line"]}}},{"code":"400","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/400/content/application~1json/examples/invalidRcId","paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/400/content/application~1json/examples/invalidLineId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/400/content/application~1json/examples/invalidRcId","paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/400/content/application~1json/examples/invalidLineId"]}}},{"code":"404","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/404/content/application~1json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-contract-lines/getrevenuecontractline"}],"panels":[]}]},"httpPath":"/contracts/{rcId}/lines/{lineId}"},{"label":"List contract lines for a charge number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-contract-lines/listrevenuecontractlinesbychargenumber","routeSlug":"/other-api/revenue-api-3.0/revenue-contract-lines/listrevenuecontractlinesbychargenumber","metadata":{"seo":{"title":"List contract lines for a charge number","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRevenueContractLinesByChargeNumber","name":"List contract lines for a charge number","isWebhook":false,"pointer":"/paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List contract lines for a charge number","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the lines of a revenue contract that came from one Zuora Billing rate plan charge."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trace a subscription charge from Zuora Billing to its revenue lines."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find the lines to target with a charge-level hold or charge-level link and delink."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always wins over a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter. The charge-number filter counts toward the limit of 5 filters, so you can add at most 4 more. No match returns HTTP 200 with an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every query parameter other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is treated as a filter."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field=value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches records where the field equals the value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field[op]=value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applies an operator. URL-encode the brackets as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%5B"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%5D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for example"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id%5Bgt%5D=1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"like"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (supply "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" wildcards yourself)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All filters are combined with AND. At most 5 filters are allowed per request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blank filter values are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unknown field or operator returns HTTP 400."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442},{"name":"chargeNumber","in":"path","schemaId":"schema_3","description":"Zuora Billing rate plan charge number.","required":true,"example":"C-00012345"}],"pointer":"/paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_61","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page number, starting at 1. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an omitted value both return the first page."},"children":[]}]}]}],"example":1},{"name":"size","in":"query","schemaId":"schema_62","description":"Records per page. Default 20, maximum 100.","example":20},{"name":"sort","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field,direction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Separate several sort fields with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id,desc;rcId,asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Direction is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; any other value sorts ascending. Sortable fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcPobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted the order is not guaranteed, so always sort when paging through results."},"children":[]}]}]}],"example":"id,asc"},{"name":"id","in":"query","schemaId":"schema_30","description":"Filter by revenue contract line ID.","example":85922},{"name":"rcPobId","in":"query","schemaId":"schema_30","description":"Filter by performance obligation (POB) ID.","example":156912},{"name":"batchId","in":"query","schemaId":"schema_30","description":"Filter by the data-collection batch that created the line.","example":5001}],"pointer":"/paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contracts/{rcId}/lines/charge-number/{chargeNumber}","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"},{"name":"chargeNumber","in":"path","required":true,"example":"C-00012345","schemaId":"schema_3"}],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_61"},{"name":"size","in":"query","required":false,"example":20,"schemaId":"schema_62"},{"name":"sort","in":"query","required":false,"example":"id,asc","schemaId":"schema_3"},{"name":"id","in":"query","required":false,"example":85922,"schemaId":"schema_30"},{"name":"rcPobId","in":"query","required":false,"example":156912,"schemaId":"schema_30"},{"name":"batchId","in":"query","required":false,"example":5001,"schemaId":"schema_30"}],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/contracts/{rcId}/lines/charge-number/{chargeNumber}","href":"revenue-contract-lines/listrevenuecontractlinesbychargenumber","openApiOperationId":"listRevenueContractLinesByChargeNumber","summary":"List contract lines for a charge number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page of records. An empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array means no record matched."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueContractLinePage","exampleIds":["paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/200/content/application~1json/examples/lines","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/200/content/application~1json/examples/empty"]}},"schemaId":"components/schemas/RevenueContractLinePage","exampleIds":["paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/200/content/application~1json/examples/lines","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/200/content/application~1json/examples/empty"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":"The request is invalid. Correct the request and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/negativePage","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/invalidPage","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/unsupportedOperator"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/negativePage","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/invalidPage","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/unsupportedOperator"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue, such as a database error or a non-numeric value supplied for a numeric filter. Retry later; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RevenueContractLinePage","exampleIds":["paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/200/content/application~1json/examples/lines","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/200/content/application~1json/examples/empty"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueContractLinePage","exampleIds":["paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/200/content/application~1json/examples/lines","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/200/content/application~1json/examples/empty"]}}},{"code":"400","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/negativePage","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/invalidPage","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/unsupportedOperator"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/negativePage","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/invalidPage","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/unsupportedOperator"]}}},{"code":"500","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-contract-lines/listrevenuecontractlinesbychargenumber"}],"panels":[]}]},"httpPath":"/contracts/{rcId}/lines/charge-number/{chargeNumber}"},{"label":"List charge lines across contracts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-contract-lines/listchargelines","routeSlug":"/other-api/revenue-api-3.0/revenue-contract-lines/listchargelines","metadata":{"seo":{"title":"List charge lines across contracts","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listChargeLines","name":"List charge lines across contracts","isWebhook":false,"pointer":"/paths/~1contracts~1charges/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List charge lines across contracts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns every revenue contract line in the book that carries a Zuora Billing charge number, across all revenue contracts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find which revenue contract a billing charge landed in when you do not know the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reconcile Zuora Billing charges with Zuora Revenue lines."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always filter or page through the results; the unfiltered list can be large."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every query parameter other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is treated as a filter."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field=value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches records where the field equals the value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field[op]=value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applies an operator. URL-encode the brackets as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%5B"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%5D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for example"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id%5Bgt%5D=1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"like"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (supply "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" wildcards yourself)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All filters are combined with AND. At most 5 filters are allowed per request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blank filter values are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unknown field or operator returns HTTP 400."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_61","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page number, starting at 1. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an omitted value both return the first page."},"children":[]}]}]}],"example":1},{"name":"size","in":"query","schemaId":"schema_62","description":"Records per page. Default 20, maximum 100.","example":20},{"name":"sort","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field,direction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Separate several sort fields with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id,desc;rcId,asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Direction is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; any other value sorts ascending. Sortable fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcPobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"batchId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted the order is not guaranteed, so always sort when paging through results."},"children":[]}]}]}],"example":"id,asc"},{"name":"id","in":"query","schemaId":"schema_30","description":"Filter by revenue contract line ID.","example":85922},{"name":"rcPobId","in":"query","schemaId":"schema_30","description":"Filter by performance obligation (POB) ID.","example":156912},{"name":"batchId","in":"query","schemaId":"schema_30","description":"Filter by the data-collection batch that created the line.","example":5001},{"name":"chargeNumber","in":"query","schemaId":"schema_3","description":"Filter by Zuora Billing rate plan charge number.","example":"C-00012345"},{"name":"rcId","in":"query","schemaId":"schema_30","description":"Filter by revenue contract ID.","example":111442}],"pointer":"/paths/~1contracts~1charges/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1contracts~1charges/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/contracts/charges","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_61"},{"name":"size","in":"query","required":false,"example":20,"schemaId":"schema_62"},{"name":"sort","in":"query","required":false,"example":"id,asc","schemaId":"schema_3"},{"name":"id","in":"query","required":false,"example":85922,"schemaId":"schema_30"},{"name":"rcPobId","in":"query","required":false,"example":156912,"schemaId":"schema_30"},{"name":"batchId","in":"query","required":false,"example":5001,"schemaId":"schema_30"},{"name":"chargeNumber","in":"query","required":false,"example":"C-00012345","schemaId":"schema_3"},{"name":"rcId","in":"query","required":false,"example":111442,"schemaId":"schema_30"}],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/contracts/charges","href":"revenue-contract-lines/listchargelines","openApiOperationId":"listChargeLines","summary":"List charge lines across contracts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page of records. An empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array means no record matched."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueContractLinePage","exampleIds":["paths/~1contracts~1charges/get/responses/200/content/application~1json/examples/byCharge","paths/~1contracts~1charges/get/responses/200/content/application~1json/examples/empty"]}},"schemaId":"components/schemas/RevenueContractLinePage","exampleIds":["paths/~1contracts~1charges/get/responses/200/content/application~1json/examples/byCharge","paths/~1contracts~1charges/get/responses/200/content/application~1json/examples/empty"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":"The request is invalid. Correct the request and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/negativePage","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/invalidPage","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/unsupportedOperator"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/negativePage","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/invalidPage","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/unsupportedOperator"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue, such as a database error or a non-numeric value supplied for a numeric filter. Retry later; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1charges/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1charges/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1contracts~1charges/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RevenueContractLinePage","exampleIds":["paths/~1contracts~1charges/get/responses/200/content/application~1json/examples/byCharge","paths/~1contracts~1charges/get/responses/200/content/application~1json/examples/empty"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueContractLinePage","exampleIds":["paths/~1contracts~1charges/get/responses/200/content/application~1json/examples/byCharge","paths/~1contracts~1charges/get/responses/200/content/application~1json/examples/empty"]}}},{"code":"400","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/negativePage","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/invalidPage","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/unsupportedOperator"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/negativePage","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/invalidPage","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/unsupportedOperator"]}}},{"code":"500","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1charges/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1contracts~1charges/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-contract-lines/listchargelines"}],"panels":[]}]},"httpPath":"/contracts/charges"}],"content":{"contentType":"group","meta":{"name":"Revenue Contract Lines"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revenue Contract Lines","showPageActions":true},{"nodeType":"markdoc","content":"Look up the lines grouped into revenue contracts, including lines by Zuora Billing charge number."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/contracts/{rcId}/lines","summary":"List lines of a revenue contract","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-contract-lines/listrevenuecontractlines","deprecated":false},{"title":"/contracts/{rcId}/lines/{lineId}","summary":"Retrieve a revenue contract line","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-contract-lines/getrevenuecontractline","deprecated":false},{"title":"/contracts/{rcId}/lines/charge-number/{chargeNumber}","summary":"List contract lines for a charge number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-contract-lines/listrevenuecontractlinesbychargenumber","deprecated":false},{"title":"/contracts/charges","summary":"List charge lines across contracts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-contract-lines/listchargelines","deprecated":false}]}]}]}]}},{"type":"group","label":"Revenue Holds","link":"/other-api/revenue-api-3.0/revenue-holds","routeSlug":"/other-api/revenue-api-3.0/revenue-holds","items":[{"label":"List revenue hold definitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-holds/listrevenueholds","routeSlug":"/other-api/revenue-api-3.0/revenue-holds/listrevenueholds","metadata":{"seo":{"title":"List revenue hold definitions","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRevenueHolds","name":"List revenue hold definitions","isWebhook":false,"pointer":"/paths/~1revenue-holds/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List revenue hold definitions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of the revenue hold definitions configured in Zuora Revenue setup."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to pass to the apply-hold and release-hold Manual Action APIs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check which holds are enabled and whether they allow manual apply or release."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only holds at the requested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdLevel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are returned, and the level defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Request "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdLevel=LINE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHARGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to list holds at other levels. The level filter always counts toward the limit of 5 filters. These are hold definitions, not the holds currently applied to contracts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every query parameter other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"size"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is treated as a filter."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field=value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" matches records where the field equals the value."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field[op]=value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" applies an operator. URL-encode the brackets as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%5B"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%5D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", for example"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id%5Bgt%5D=1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Operators: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ne"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"like"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (supply "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" wildcards yourself)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All filters are combined with AND. At most 5 filters are allowed per request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Blank filter values are ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unknown field or operator returns HTTP 400."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_61","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page number, starting at 1. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an omitted value both return the first page."},"children":[]}]}]}],"example":1},{"name":"size","in":"query","schemaId":"schema_62","description":"Records per page. Default 20, maximum 100.","example":20},{"name":"sort","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort order as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"field,direction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Separate several sort fields with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":";"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id,desc;rcId,asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Direction is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; any other value sorts ascending. Sortable fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdLevel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted the order is not guaranteed, so always sort when paging through results."},"children":[]}]}]}],"example":"id,asc"},{"name":"holdLevel","in":"query","schemaId":"schema_66","description":"Hold level to list. Case-insensitive.","example":"RC"},{"name":"id","in":"query","schemaId":"schema_30","description":"Filter by hold definition ID.","example":20},{"name":"name","in":"query","schemaId":"schema_3","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by hold name. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name[like]=%Acceptance%"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a partial match."},"children":[]}]}]}],"example":"Pending Acceptance"},{"name":"startDate","in":"query","schemaId":"schema_3","description":"Filter by hold start date.","example":"2026-01-01"},{"name":"endDate","in":"query","schemaId":"schema_3","description":"Filter by hold end date.","example":"2026-12-31"}],"pointer":"/paths/~1revenue-holds/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-holds/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenue-holds","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"example":1,"schemaId":"schema_61"},{"name":"size","in":"query","required":false,"example":20,"schemaId":"schema_62"},{"name":"sort","in":"query","required":false,"example":"id,asc","schemaId":"schema_3"},{"name":"holdLevel","in":"query","required":false,"example":"RC","schemaId":"schema_66"},{"name":"id","in":"query","required":false,"example":20,"schemaId":"schema_30"},{"name":"name","in":"query","required":false,"example":"Pending Acceptance","schemaId":"schema_3"},{"name":"startDate","in":"query","required":false,"example":"2026-01-01","schemaId":"schema_3"},{"name":"endDate","in":"query","required":false,"example":"2026-12-31","schemaId":"schema_3"}],"querystring":[],"header":[{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/revenue-holds","href":"revenue-holds/listrevenueholds","openApiOperationId":"listRevenueHolds","summary":"List revenue hold definitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A page of records. An empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array means no record matched."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueHoldPage","exampleIds":["paths/~1revenue-holds/get/responses/200/content/application~1json/examples/rcHolds","paths/~1revenue-holds/get/responses/200/content/application~1json/examples/empty"]}},"schemaId":"components/schemas/RevenueHoldPage","exampleIds":["paths/~1revenue-holds/get/responses/200/content/application~1json/examples/rcHolds","paths/~1revenue-holds/get/responses/200/content/application~1json/examples/empty"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":"The request is invalid. Correct the request and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds/get/responses/400/content/application~1json/examples/invalidHoldLevel","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/blankHoldLevel","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/negativePage","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/invalidPage","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/unsupportedOperator"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds/get/responses/400/content/application~1json/examples/invalidHoldLevel","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/blankHoldLevel","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/negativePage","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/invalidPage","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/unsupportedOperator"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue, such as a database error or a non-numeric value supplied for a numeric filter. Retry later; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1revenue-holds/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RevenueHoldPage","exampleIds":["paths/~1revenue-holds/get/responses/200/content/application~1json/examples/rcHolds","paths/~1revenue-holds/get/responses/200/content/application~1json/examples/empty"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueHoldPage","exampleIds":["paths/~1revenue-holds/get/responses/200/content/application~1json/examples/rcHolds","paths/~1revenue-holds/get/responses/200/content/application~1json/examples/empty"]}}},{"code":"400","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds/get/responses/400/content/application~1json/examples/invalidHoldLevel","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/blankHoldLevel","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/negativePage","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/invalidPage","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/unsupportedOperator"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds/get/responses/400/content/application~1json/examples/invalidHoldLevel","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/blankHoldLevel","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/unknownFilter","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/pageSizeTooLarge","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/pageSizeNotPositive","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/negativePage","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/invalidPage","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/tooManyFilters","paths/~1revenue-holds/get/responses/400/content/application~1json/examples/unsupportedOperator"]}}},{"code":"500","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-holds/listrevenueholds"}],"panels":[]}]},"httpPath":"/revenue-holds"},{"label":"Retrieve a revenue hold definition","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-holds/getrevenuehold","routeSlug":"/other-api/revenue-api-3.0/revenue-holds/getrevenuehold","metadata":{"seo":{"title":"Retrieve a revenue hold definition","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRevenueHold","name":"Retrieve a revenue hold definition","isWebhook":false,"pointer":"/paths/~1revenue-holds~1{holdId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a revenue hold definition","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns one revenue hold definition, at any hold level."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Confirm a hold's level, type, and manual apply or release settings before you apply or release it on a contract."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"holdId","in":"path","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue hold definition ID. List holds with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /revenue-holds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":20}],"pointer":"/paths/~1revenue-holds~1{holdId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-holds~1{holdId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenue-holds/{holdId}","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"holdId","in":"path","required":true,"example":20,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/revenue-holds/{holdId}","href":"revenue-holds/getrevenuehold","openApiOperationId":"getRevenueHold","summary":"Retrieve a revenue hold definition"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The revenue hold definition.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueHold","exampleIds":["paths/~1revenue-holds~1{holdId}/get/responses/200/content/application~1json/examples/hold"]}},"schemaId":"components/schemas/RevenueHold","exampleIds":["paths/~1revenue-holds~1{holdId}/get/responses/200/content/application~1json/examples/hold"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":"The request is invalid. Correct the request and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds~1{holdId}/get/responses/400/content/application~1json/examples/invalidHoldId"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds~1{holdId}/get/responses/400/content/application~1json/examples/invalidHoldId"]},{"code":"404","description":"The revenue hold does not exist in this tenant and book, or the caller's organization cannot see it.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds~1{holdId}/get/responses/404/content/application~1json/examples/notFound"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds~1{holdId}/get/responses/404/content/application~1json/examples/notFound"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue, such as a database error or a non-numeric value supplied for a numeric filter. Retry later; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds~1{holdId}/get/responses/500/content/application~1json/examples/internalError"]}},"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds~1{holdId}/get/responses/500/content/application~1json/examples/internalError"]}],"pointer":"/paths/~1revenue-holds~1{holdId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RevenueHold","exampleIds":["paths/~1revenue-holds~1{holdId}/get/responses/200/content/application~1json/examples/hold"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueHold","exampleIds":["paths/~1revenue-holds~1{holdId}/get/responses/200/content/application~1json/examples/hold"]}}},{"code":"400","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds~1{holdId}/get/responses/400/content/application~1json/examples/invalidHoldId"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds~1{holdId}/get/responses/400/content/application~1json/examples/invalidHoldId"]}}},{"code":"404","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds~1{holdId}/get/responses/404/content/application~1json/examples/notFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds~1{holdId}/get/responses/404/content/application~1json/examples/notFound"]}}},{"code":"500","schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds~1{holdId}/get/responses/500/content/application~1json/examples/internalError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContractQueryErrorResponse","exampleIds":["paths/~1revenue-holds~1{holdId}/get/responses/500/content/application~1json/examples/internalError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-holds/getrevenuehold"}],"panels":[]}]},"httpPath":"/revenue-holds/{holdId}"}],"content":{"contentType":"group","meta":{"name":"Revenue Holds"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revenue Holds","showPageActions":true},{"nodeType":"markdoc","content":"Look up revenue hold definitions to apply or release with the Manual Action APIs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue-holds","summary":"List revenue hold definitions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-holds/listrevenueholds","deprecated":false},{"title":"/revenue-holds/{holdId}","summary":"Retrieve a revenue hold definition","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-holds/getrevenuehold","deprecated":false}]}]}]}]}},{"type":"group","label":"Contract Status","link":"/other-api/revenue-api-3.0/contract-status","routeSlug":"/other-api/revenue-api-3.0/contract-status","items":[{"label":"Open or close a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-status/openorcloserevenuecontract","routeSlug":"/other-api/revenue-api-3.0/contract-status/openorcloserevenuecontract","metadata":{"seo":{"title":"Open or close a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"openOrCloseRevenueContract","name":"Open or close a revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Open or close a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changes the status of a revenue contract to closed or back to open."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"close"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": when a contract is complete (for example all revenue is recognized) and must no longer be reprocessed or changed by new transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"open"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": when a closed contract must be changed again, for example to correct data or apply a modification."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path value is case-insensitive."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442},{"name":"action","in":"path","schemaId":"schema_67","description":"Status change to make.","required":true,"example":"close"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OpenCloseRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/requestBody/content/application~1json/examples/currentVersion","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/requestBody/content/application~1json/examples/explicitVersion"]}},"schemaId":"components/schemas/OpenCloseRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/requestBody/content/application~1json/examples/currentVersion","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/requestBody/content/application~1json/examples/explicitVersion"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/open-close/{action}","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"},{"name":"action","in":"path","required":true,"example":"close","schemaId":"schema_67"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OpenCloseRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/requestBody/content/application~1json/examples/currentVersion","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/requestBody/content/application~1json/examples/explicitVersion"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/open-close/{action}","href":"contract-status/openorcloserevenuecontract","openApiOperationId":"openOrCloseRevenueContract","summary":"Open or close a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/OpenCloseRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/requestBody/content/application~1json/examples/currentVersion","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/requestBody/content/application~1json/examples/explicitVersion"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OpenCloseRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/requestBody/content/application~1json/examples/currentVersion","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/requestBody/content/application~1json/examples/explicitVersion"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/closed","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/opened","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/closed","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/opened","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/invalidAction","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/invalidAction","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/closed","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/opened","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/closed","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/opened","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/invalidAction","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/invalidAction","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-status/openorcloserevenuecontract"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/open-close/{action}"},{"label":"Unfreeze a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-status/unfreezerevenuecontract","routeSlug":"/other-api/revenue-api-3.0/contract-status/unfreezerevenuecontract","metadata":{"seo":{"title":"Unfreeze a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unfreezeRevenueContract","name":"Unfreeze a revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unfreeze a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes the freeze from a frozen revenue contract so its lines and schedules can be changed and processed again."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A contract was frozen (for example by a soft-freeze during close) and you need to make a correction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"changeModDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the unfreeze must not change the contract modification date."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors from the revenue engine for this operation are returned as HTTP 200 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the generic message shown in the examples, not as 4xx/5xx responses."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UnfreezeRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/requestBody/content/application~1json/examples/unfreeze","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/requestBody/content/application~1json/examples/keepModDate"]}},"schemaId":"components/schemas/UnfreezeRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/requestBody/content/application~1json/examples/unfreeze","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/requestBody/content/application~1json/examples/keepModDate"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/unfreeze","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UnfreezeRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/requestBody/content/application~1json/examples/unfreeze","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/requestBody/content/application~1json/examples/keepModDate"]}},"responseCodes":["200","400","404","500"],"pointer":"/revenue-management/contracts/{rcId}/unfreeze","href":"contract-status/unfreezerevenuecontract","openApiOperationId":"unfreezeRevenueContract","summary":"Unfreeze a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/UnfreezeRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/requestBody/content/application~1json/examples/unfreeze","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/requestBody/content/application~1json/examples/keepModDate"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UnfreezeRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/requestBody/content/application~1json/examples/unfreeze","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/requestBody/content/application~1json/examples/keepModDate"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/unfrozen","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/engineError"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/unfrozen","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/engineError"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/missingAction","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/invalidBookHeader"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/missingAction","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/invalidBookHeader"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/404/content/application~1json/examples/contractNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/404/content/application~1json/examples/contractNotFound"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/500/content/application~1json/examples/systemError"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/unfrozen","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/engineError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/unfrozen","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/engineError"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/missingAction","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/invalidBookHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/missingAction","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/invalidBookHeader"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/404/content/application~1json/examples/contractNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/404/content/application~1json/examples/contractNotFound"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/500/content/application~1json/examples/systemError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-status/unfreezerevenuecontract"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/unfreeze"}],"content":{"contentType":"group","meta":{"name":"Contract Status"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contract Status","showPageActions":true},{"nodeType":"markdoc","content":"Open, close, and unfreeze revenue contracts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue-management/contracts/{rcId}/open-close/{action}","summary":"Open or close a revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contract-status/openorcloserevenuecontract","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/unfreeze","summary":"Unfreeze a revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contract-status/unfreezerevenuecontract","deprecated":false}]}]}]}]}},{"type":"group","label":"Apply and Release Holds","link":"/other-api/revenue-api-3.0/apply-and-release-holds","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds","items":[{"label":"Apply a hold to a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/apply-and-release-holds/applycontracthold","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds/applycontracthold","metadata":{"seo":{"title":"Apply a hold to a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"applyContractHold","name":"Apply a hold to a revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply a hold to a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies a revenue hold definition to the whole revenue contract. While the hold is in place, Zuora Revenue blocks the revenue recognition (or transfer) that the hold type covers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue must not be recognized until a condition is met, for example customer acceptance, a credit check, or an audit, and the condition applies to the whole contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use a hold definition whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags.holdLevel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags.allowManualApply"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". List them with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /revenue-holds?holdLevel=RC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442},{"name":"holdId","in":"path","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue hold definition ID. List holds with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /revenue-holds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":20}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyHoldRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"]}},"schemaId":"components/schemas/ApplyHoldRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/holds/{holdId}/apply","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"},{"name":"holdId","in":"path","required":true,"example":20,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplyHoldRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/holds/{holdId}/apply","href":"apply-and-release-holds/applycontracthold","openApiOperationId":"applyContractHold","summary":"Apply a hold to a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/ApplyHoldRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyHoldRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplyHoldResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"]}},"schemaId":"components/schemas/ApplyHoldResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplyHoldResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplyHoldResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apply-and-release-holds/applycontracthold"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/holds/{holdId}/apply"},{"label":"Release a hold from a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/apply-and-release-holds/releasecontracthold","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds/releasecontracthold","metadata":{"seo":{"title":"Release a hold from a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"releaseContractHold","name":"Release a hold from a revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Release a hold from a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Releases a revenue hold previously applied to the revenue contract, so the blocked revenue recognition (or transfer) resumes. The release comment and reason are recorded for audit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The condition behind the hold is met, for example acceptance was received or the audit finished."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The hold definition must allow manual release ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags.allowManualRelease"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442},{"name":"holdId","in":"path","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue hold definition ID. List holds with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /revenue-holds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":20}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReleaseHoldRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"]}},"schemaId":"components/schemas/ReleaseHoldRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/holds/{holdId}/release","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"},{"name":"holdId","in":"path","required":true,"example":20,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReleaseHoldRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/holds/{holdId}/release","href":"apply-and-release-holds/releasecontracthold","openApiOperationId":"releaseContractHold","summary":"Release a hold from a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/ReleaseHoldRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReleaseHoldRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apply-and-release-holds/releasecontracthold"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/holds/{holdId}/release"},{"label":"Apply a hold to contract lines","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/apply-and-release-holds/applylinehold","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds/applylinehold","metadata":{"seo":{"title":"Apply a hold to contract lines","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"applyLineHold","name":"Apply a hold to contract lines","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply a hold to contract lines","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies a revenue hold definition to selected lines of a revenue contract. While the hold is in place, Zuora Revenue blocks the revenue recognition (or transfer) that the hold type covers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue must not be recognized until a condition is met, for example customer acceptance, a credit check, or an audit, and the condition applies to specific lines."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use a hold definition whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags.holdLevel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LINE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags.allowManualApply"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". List them with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /revenue-holds?holdLevel=LINE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442},{"name":"holdId","in":"path","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue hold definition ID. List holds with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /revenue-holds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":20}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"]}},"schemaId":"components/schemas/ApplyHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/lines/holds/{holdId}/apply","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"},{"name":"holdId","in":"path","required":true,"example":20,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplyHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/lines/holds/{holdId}/apply","href":"apply-and-release-holds/applylinehold","openApiOperationId":"applyLineHold","summary":"Apply a hold to contract lines"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/ApplyHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplyHoldResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"]}},"schemaId":"components/schemas/ApplyHoldResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplyHoldResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplyHoldResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apply-and-release-holds/applylinehold"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/lines/holds/{holdId}/apply"},{"label":"Release a hold from contract lines","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/apply-and-release-holds/releaselinehold","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds/releaselinehold","metadata":{"seo":{"title":"Release a hold from contract lines","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"releaseLineHold","name":"Release a hold from contract lines","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Release a hold from contract lines","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Releases a revenue hold previously applied to selected lines, so the blocked revenue recognition (or transfer) resumes. The release comment and reason are recorded for audit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The condition behind the hold is met, for example acceptance was received or the audit finished."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The hold definition must allow manual release ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags.allowManualRelease"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442},{"name":"holdId","in":"path","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue hold definition ID. List holds with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /revenue-holds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":20}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReleaseHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"]}},"schemaId":"components/schemas/ReleaseHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/lines/holds/{holdId}/release","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"},{"name":"holdId","in":"path","required":true,"example":20,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReleaseHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/lines/holds/{holdId}/release","href":"apply-and-release-holds/releaselinehold","openApiOperationId":"releaseLineHold","summary":"Release a hold from contract lines"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/ReleaseHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReleaseHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apply-and-release-holds/releaselinehold"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/lines/holds/{holdId}/release"},{"label":"Apply a hold to contract POBs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/apply-and-release-holds/applypobhold","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds/applypobhold","metadata":{"seo":{"title":"Apply a hold to contract POBs","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"applyPobHold","name":"Apply a hold to contract POBs","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply a hold to contract POBs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies a revenue hold definition to selected POBs of a revenue contract. While the hold is in place, Zuora Revenue blocks the revenue recognition (or transfer) that the hold type covers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue must not be recognized until a condition is met, for example customer acceptance, a credit check, or an audit, and the condition applies to specific POBs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use a hold definition whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags.holdLevel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags.allowManualApply"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". List them with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /revenue-holds?holdLevel=POB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcPobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442},{"name":"holdId","in":"path","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue hold definition ID. List holds with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /revenue-holds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":20}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"]}},"schemaId":"components/schemas/ApplyHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/pobs/holds/{holdId}/apply","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"},{"name":"holdId","in":"path","required":true,"example":20,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplyHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/pobs/holds/{holdId}/apply","href":"apply-and-release-holds/applypobhold","openApiOperationId":"applyPobHold","summary":"Apply a hold to contract POBs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/ApplyHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplyHoldResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"]}},"schemaId":"components/schemas/ApplyHoldResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplyHoldResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplyHoldResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apply-and-release-holds/applypobhold"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/pobs/holds/{holdId}/apply"},{"label":"Release a hold from contract POBs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/apply-and-release-holds/releasepobhold","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds/releasepobhold","metadata":{"seo":{"title":"Release a hold from contract POBs","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"releasePobHold","name":"Release a hold from contract POBs","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Release a hold from contract POBs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Releases a revenue hold previously applied to selected POBs, so the blocked revenue recognition (or transfer) resumes. The release comment and reason are recorded for audit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The condition behind the hold is met, for example acceptance was received or the audit finished."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The hold definition must allow manual release ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags.allowManualRelease"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcPobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442},{"name":"holdId","in":"path","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue hold definition ID. List holds with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /revenue-holds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":20}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReleaseHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"]}},"schemaId":"components/schemas/ReleaseHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/pobs/holds/{holdId}/release","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"},{"name":"holdId","in":"path","required":true,"example":20,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReleaseHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/pobs/holds/{holdId}/release","href":"apply-and-release-holds/releasepobhold","openApiOperationId":"releasePobHold","summary":"Release a hold from contract POBs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/ReleaseHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReleaseHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apply-and-release-holds/releasepobhold"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/pobs/holds/{holdId}/release"},{"label":"Apply a hold to contract charges","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/apply-and-release-holds/applychargehold","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds/applychargehold","metadata":{"seo":{"title":"Apply a hold to contract charges","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"applyChargeHold","name":"Apply a hold to contract charges","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply a hold to contract charges","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies a revenue hold definition to selected charges of a revenue contract. While the hold is in place, Zuora Revenue blocks the revenue recognition (or transfer) that the hold type covers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue must not be recognized until a condition is met, for example customer acceptance, a credit check, or an audit, and the condition applies to specific charges."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use a hold definition whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags.holdLevel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHARGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags.allowManualApply"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". List them with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /revenue-holds?holdLevel=CHARGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442},{"name":"holdId","in":"path","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue hold definition ID. List holds with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /revenue-holds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":20}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"]}},"schemaId":"components/schemas/ApplyHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/charges/holds/{holdId}/apply","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"},{"name":"holdId","in":"path","required":true,"example":20,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplyHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/charges/holds/{holdId}/apply","href":"apply-and-release-holds/applychargehold","openApiOperationId":"applyChargeHold","summary":"Apply a hold to contract charges"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/ApplyHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplyHoldResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"]}},"schemaId":"components/schemas/ApplyHoldResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplyHoldResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplyHoldResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apply-and-release-holds/applychargehold"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/charges/holds/{holdId}/apply"},{"label":"Release a hold from contract charges","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/apply-and-release-holds/releasechargehold","routeSlug":"/other-api/revenue-api-3.0/apply-and-release-holds/releasechargehold","metadata":{"seo":{"title":"Release a hold from contract charges","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"releaseChargeHold","name":"Release a hold from contract charges","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Release a hold from contract charges","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Releases a revenue hold previously applied to selected charges, so the blocked revenue recognition (or transfer) resumes. The release comment and reason are recorded for audit."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The condition behind the hold is met, for example acceptance was received or the audit finished."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The hold definition must allow manual release ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags.allowManualRelease"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each item in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"chargeNumber"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442},{"name":"holdId","in":"path","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue hold definition ID. List holds with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /revenue-holds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":20}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReleaseHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"]}},"schemaId":"components/schemas/ReleaseHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/charges/holds/{holdId}/release","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"},{"name":"holdId","in":"path","required":true,"example":20,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ReleaseHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/charges/holds/{holdId}/release","href":"apply-and-release-holds/releasechargehold","openApiOperationId":"releaseChargeHold","summary":"Release a hold from contract charges"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/ReleaseHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReleaseHoldItemsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/apply-and-release-holds/releasechargehold"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/charges/holds/{holdId}/release"}],"content":{"contentType":"group","meta":{"name":"Apply and Release Holds"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply and Release Holds","showPageActions":true},{"nodeType":"markdoc","content":"Apply and release revenue holds at contract, line, POB, or charge level."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue-management/contracts/{rcId}/holds/{holdId}/apply","summary":"Apply a hold to a revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/apply-and-release-holds/applycontracthold","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/holds/{holdId}/release","summary":"Release a hold from a revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/apply-and-release-holds/releasecontracthold","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/lines/holds/{holdId}/apply","summary":"Apply a hold to contract lines","prefix":{"name":"post","color":"post"},"badges":[],"link":"/apply-and-release-holds/applylinehold","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/lines/holds/{holdId}/release","summary":"Release a hold from contract lines","prefix":{"name":"post","color":"post"},"badges":[],"link":"/apply-and-release-holds/releaselinehold","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/pobs/holds/{holdId}/apply","summary":"Apply a hold to contract POBs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/apply-and-release-holds/applypobhold","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/pobs/holds/{holdId}/release","summary":"Release a hold from contract POBs","prefix":{"name":"post","color":"post"},"badges":[],"link":"/apply-and-release-holds/releasepobhold","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/charges/holds/{holdId}/apply","summary":"Apply a hold to contract charges","prefix":{"name":"post","color":"post"},"badges":[],"link":"/apply-and-release-holds/applychargehold","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/charges/holds/{holdId}/release","summary":"Release a hold from contract charges","prefix":{"name":"post","color":"post"},"badges":[],"link":"/apply-and-release-holds/releasechargehold","deprecated":false}]}]}]}]}},{"type":"group","label":"Revenue Deferral and Release","link":"/other-api/revenue-api-3.0/revenue-deferral-and-release","routeSlug":"/other-api/revenue-api-3.0/revenue-deferral-and-release","items":[{"label":"Defer revenue for a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-deferral-and-release/deferrevenueforcontract","routeSlug":"/other-api/revenue-api-3.0/revenue-deferral-and-release/deferrevenueforcontract","metadata":{"seo":{"title":"Defer revenue for a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deferRevenueForContract","name":"Defer revenue for a revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Defer revenue for a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Places a manual deferral on the revenue contract, or on selected POBs of it, so its scheduled revenue is held back instead of being recognized, optionally for a date window."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue must not be recognized yet even though the schedule says so, for example because of an unresolved contingency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pair it with the release-revenue operation when the contingency is resolved."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors from the revenue engine for this operation are returned as HTTP 200 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the generic message shown in the examples, not as 4xx/5xx responses."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeferReleaseRevenueRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/requestBody/content/application~1json/examples/window","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/requestBody/content/application~1json/examples/somePobs"]}},"schemaId":"components/schemas/DeferReleaseRevenueRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/requestBody/content/application~1json/examples/window","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/requestBody/content/application~1json/examples/somePobs"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/defer-revenue","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DeferReleaseRevenueRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/requestBody/content/application~1json/examples/window","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/requestBody/content/application~1json/examples/somePobs"]}},"responseCodes":["200","400","404","500"],"pointer":"/revenue-management/contracts/{rcId}/defer-revenue","href":"revenue-deferral-and-release/deferrevenueforcontract","openApiOperationId":"deferRevenueForContract","summary":"Defer revenue for a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/DeferReleaseRevenueRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/requestBody/content/application~1json/examples/window","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/requestBody/content/application~1json/examples/somePobs"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeferReleaseRevenueRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/requestBody/content/application~1json/examples/window","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/requestBody/content/application~1json/examples/somePobs"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/engineError"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/engineError"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/404/content/application~1json/examples/contractNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/404/content/application~1json/examples/contractNotFound"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/500/content/application~1json/examples/systemError"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/engineError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/engineError"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/404/content/application~1json/examples/contractNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/404/content/application~1json/examples/contractNotFound"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/500/content/application~1json/examples/systemError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-deferral-and-release/deferrevenueforcontract"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/defer-revenue"},{"label":"Defer revenue for a POB","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-deferral-and-release/deferrevenueforpob","routeSlug":"/other-api/revenue-api-3.0/revenue-deferral-and-release/deferrevenueforpob","metadata":{"seo":{"title":"Defer revenue for a POB","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deferRevenueForPob","name":"Defer revenue for a POB","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Defer revenue for a POB","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Places a manual deferral on one POB so its scheduled revenue is held back instead of being recognized, optionally for a date window."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue must not be recognized yet even though the schedule says so, for example because of an unresolved contingency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pair it with the release-revenue operation when the contingency is resolved."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors from the revenue engine for this operation are returned as HTTP 200 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the generic message shown in the examples, not as 4xx/5xx responses."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442},{"name":"pobId","in":"path","schemaId":"schema_30","description":"Performance obligation (POB) ID.","required":true,"example":156912}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeferReleaseRevenuePobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/requestBody/content/application~1json/examples/window"]}},"schemaId":"components/schemas/DeferReleaseRevenuePobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/requestBody/content/application~1json/examples/window"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/pobs/{pobId}/defer-revenue","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"},{"name":"pobId","in":"path","required":true,"example":156912,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DeferReleaseRevenuePobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/requestBody/content/application~1json/examples/window"]}},"responseCodes":["200","400","404","500"],"pointer":"/revenue-management/contracts/{rcId}/pobs/{pobId}/defer-revenue","href":"revenue-deferral-and-release/deferrevenueforpob","openApiOperationId":"deferRevenueForPob","summary":"Defer revenue for a POB"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/DeferReleaseRevenuePobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/requestBody/content/application~1json/examples/window"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeferReleaseRevenuePobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/requestBody/content/application~1json/examples/window"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/engineError"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/engineError"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/404/content/application~1json/examples/contractNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/404/content/application~1json/examples/contractNotFound"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/500/content/application~1json/examples/systemError"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/engineError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/engineError"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/404/content/application~1json/examples/contractNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/404/content/application~1json/examples/contractNotFound"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/500/content/application~1json/examples/systemError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-deferral-and-release/deferrevenueforpob"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/pobs/{pobId}/defer-revenue"},{"label":"Release revenue for a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-deferral-and-release/releaserevenueforcontract","routeSlug":"/other-api/revenue-api-3.0/revenue-deferral-and-release/releaserevenueforcontract","metadata":{"seo":{"title":"Release revenue for a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"releaseRevenueForContract","name":"Release revenue for a revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Release revenue for a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Releases revenue previously deferred on the revenue contract, or on selected POBs of it, so it is recognized. Release the full amount, or part of it by amount or percentage."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contingency behind a manual deferral is resolved."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"releaseAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"releasePercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a partial release."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors from the revenue engine for this operation are returned as HTTP 200 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the generic message shown in the examples, not as 4xx/5xx responses."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeferReleaseRevenueRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/full","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/percentage","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/amount","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/somePobs"]}},"schemaId":"components/schemas/DeferReleaseRevenueRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/full","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/percentage","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/amount","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/somePobs"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/release-revenue","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DeferReleaseRevenueRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/full","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/percentage","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/amount","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/somePobs"]}},"responseCodes":["200","400","404","500"],"pointer":"/revenue-management/contracts/{rcId}/release-revenue","href":"revenue-deferral-and-release/releaserevenueforcontract","openApiOperationId":"releaseRevenueForContract","summary":"Release revenue for a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/DeferReleaseRevenueRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/full","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/percentage","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/amount","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/somePobs"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeferReleaseRevenueRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/full","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/percentage","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/amount","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/somePobs"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/engineError"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/engineError"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/404/content/application~1json/examples/contractNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/404/content/application~1json/examples/contractNotFound"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/500/content/application~1json/examples/systemError"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/engineError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/engineError"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/404/content/application~1json/examples/contractNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/404/content/application~1json/examples/contractNotFound"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/500/content/application~1json/examples/systemError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-deferral-and-release/releaserevenueforcontract"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/release-revenue"},{"label":"Release revenue for a POB","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/revenue-deferral-and-release/releaserevenueforpob","routeSlug":"/other-api/revenue-api-3.0/revenue-deferral-and-release/releaserevenueforpob","metadata":{"seo":{"title":"Release revenue for a POB","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"releaseRevenueForPob","name":"Release revenue for a POB","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Release revenue for a POB","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Releases revenue previously deferred on one POB so it is recognized. Release the full amount, or part of it by amount or percentage."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contingency behind a manual deferral is resolved."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"releaseAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"releasePercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a partial release."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors from the revenue engine for this operation are returned as HTTP 200 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the generic message shown in the examples, not as 4xx/5xx responses."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442},{"name":"pobId","in":"path","schemaId":"schema_30","description":"Performance obligation (POB) ID.","required":true,"example":156912}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeferReleaseRevenuePobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/full","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/percentage","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/amount"]}},"schemaId":"components/schemas/DeferReleaseRevenuePobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/full","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/percentage","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/amount"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/pobs/{pobId}/release-revenue","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"},{"name":"pobId","in":"path","required":true,"example":156912,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DeferReleaseRevenuePobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/full","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/percentage","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/amount"]}},"responseCodes":["200","400","404","500"],"pointer":"/revenue-management/contracts/{rcId}/pobs/{pobId}/release-revenue","href":"revenue-deferral-and-release/releaserevenueforpob","openApiOperationId":"releaseRevenueForPob","summary":"Release revenue for a POB"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/DeferReleaseRevenuePobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/full","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/percentage","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/amount"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeferReleaseRevenuePobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/full","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/percentage","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/amount"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/engineError"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/engineError"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/404/content/application~1json/examples/contractNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/404/content/application~1json/examples/contractNotFound"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/500/content/application~1json/examples/systemError"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/engineError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/engineError"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/404/content/application~1json/examples/contractNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/404/content/application~1json/examples/contractNotFound"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/500/content/application~1json/examples/systemError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-deferral-and-release/releaserevenueforpob"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/pobs/{pobId}/release-revenue"}],"content":{"contentType":"group","meta":{"name":"Revenue Deferral and Release"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revenue Deferral and Release","showPageActions":true},{"nodeType":"markdoc","content":"Manually defer and release revenue."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue-management/contracts/{rcId}/defer-revenue","summary":"Defer revenue for a revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/revenue-deferral-and-release/deferrevenueforcontract","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/pobs/{pobId}/defer-revenue","summary":"Defer revenue for a POB","prefix":{"name":"post","color":"post"},"badges":[],"link":"/revenue-deferral-and-release/deferrevenueforpob","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/release-revenue","summary":"Release revenue for a revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/revenue-deferral-and-release/releaserevenueforcontract","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/pobs/{pobId}/release-revenue","summary":"Release revenue for a POB","prefix":{"name":"post","color":"post"},"badges":[],"link":"/revenue-deferral-and-release/releaserevenueforpob","deprecated":false}]}]}]}]}},{"type":"group","label":"Cost Deferral and Release","link":"/other-api/revenue-api-3.0/cost-deferral-and-release","routeSlug":"/other-api/revenue-api-3.0/cost-deferral-and-release","items":[{"label":"Defer cost on a contract line","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/cost-deferral-and-release/defercost","routeSlug":"/other-api/revenue-api-3.0/cost-deferral-and-release/defercost","metadata":{"seo":{"title":"Defer cost on a contract line","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deferCost","name":"Defer cost on a contract line","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Defer cost on a contract line","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defers a cost (for example a commission or fulfillment cost) on a revenue contract line so it is amortized under the cost rule dates instead of being expensed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A capitalized contract cost must be amortized over a specific window."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleStartDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ruleEndDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the amortization window."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors from the revenue engine for this operation are returned as HTTP 200 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the generic message shown in the examples, not as 4xx/5xx responses."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeferReleaseCostRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/requestBody/content/application~1json/examples/defer"]}},"schemaId":"components/schemas/DeferReleaseCostRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/requestBody/content/application~1json/examples/defer"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/defer-cost","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DeferReleaseCostRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/requestBody/content/application~1json/examples/defer"]}},"responseCodes":["200","400","404","500"],"pointer":"/revenue-management/contracts/{rcId}/defer-cost","href":"cost-deferral-and-release/defercost","openApiOperationId":"deferCost","summary":"Defer cost on a contract line"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/DeferReleaseCostRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/requestBody/content/application~1json/examples/defer"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeferReleaseCostRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/requestBody/content/application~1json/examples/defer"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/engineError"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/engineError"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/invalidBookHeader"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/invalidBookHeader"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/404/content/application~1json/examples/contractNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/404/content/application~1json/examples/contractNotFound"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/500/content/application~1json/examples/systemError"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/engineError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/engineError"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/invalidBookHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/invalidBookHeader"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/404/content/application~1json/examples/contractNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/404/content/application~1json/examples/contractNotFound"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/500/content/application~1json/examples/systemError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cost-deferral-and-release/defercost"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/defer-cost"},{"label":"Release cost on a contract line","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/cost-deferral-and-release/releasecost","routeSlug":"/other-api/revenue-api-3.0/cost-deferral-and-release/releasecost","metadata":{"seo":{"title":"Release cost on a contract line","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"releaseCost","name":"Release cost on a contract line","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Release cost on a contract line","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Releases a deferred cost on a revenue contract line so it is expensed, fully or partially by amount, percentage, or quantity."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A deferred cost must be expensed now, for example when the contract is terminated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"releaseAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"releasePercentage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"releaseQuantity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a partial release."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors from the revenue engine for this operation are returned as HTTP 200 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the generic message shown in the examples, not as 4xx/5xx responses."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeferReleaseCostRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/requestBody/content/application~1json/examples/amount","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/requestBody/content/application~1json/examples/percentage"]}},"schemaId":"components/schemas/DeferReleaseCostRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/requestBody/content/application~1json/examples/amount","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/requestBody/content/application~1json/examples/percentage"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/release-cost","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DeferReleaseCostRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/requestBody/content/application~1json/examples/amount","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/requestBody/content/application~1json/examples/percentage"]}},"responseCodes":["200","400","404","500"],"pointer":"/revenue-management/contracts/{rcId}/release-cost","href":"cost-deferral-and-release/releasecost","openApiOperationId":"releaseCost","summary":"Release cost on a contract line"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/DeferReleaseCostRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/requestBody/content/application~1json/examples/amount","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/requestBody/content/application~1json/examples/percentage"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DeferReleaseCostRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/requestBody/content/application~1json/examples/amount","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/requestBody/content/application~1json/examples/percentage"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/engineError"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/engineError"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/invalidBookHeader"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/invalidBookHeader"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/404/content/application~1json/examples/contractNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/404/content/application~1json/examples/contractNotFound"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/500/content/application~1json/examples/systemError"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/engineError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/engineError"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/invalidBookHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/invalidBookHeader"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/404/content/application~1json/examples/contractNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/404/content/application~1json/examples/contractNotFound"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/500/content/application~1json/examples/systemError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cost-deferral-and-release/releasecost"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/release-cost"}],"content":{"contentType":"group","meta":{"name":"Cost Deferral and Release"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cost Deferral and Release","showPageActions":true},{"nodeType":"markdoc","content":"Defer and release contract costs on a line."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue-management/contracts/{rcId}/defer-cost","summary":"Defer cost on a contract line","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cost-deferral-and-release/defercost","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/release-cost","summary":"Release cost on a contract line","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cost-deferral-and-release/releasecost","deprecated":false}]}]}]}]}},{"type":"group","label":"Allocation","link":"/other-api/revenue-api-3.0/allocation","routeSlug":"/other-api/revenue-api-3.0/allocation","items":[{"label":"Reallocate or mark a contract allocation-eligible","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/allocation/performallocationaction","routeSlug":"/other-api/revenue-api-3.0/allocation/performallocationaction","metadata":{"seo":{"title":"Reallocate or mark a contract allocation-eligible","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"performAllocationAction","name":"Reallocate or mark a contract allocation-eligible","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reallocate or mark a contract allocation-eligible","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Runs an allocation action on the revenue contract. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REALLOCATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" re-runs the allocation of the transaction price across the contract's POBs based on standalone selling prices (SSP). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALLOCATION_ELIGIBLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" makes the contract eligible for allocation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REALLOCATE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": after SSPs, prices, or POB structure changed and the allocation must be recalculated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALLOCATION_ELIGIBLE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": when a contract that was excluded from allocation must now be allocated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is case-sensitive."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AllocateActionRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/requestBody/content/application~1json/examples/reallocate","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/requestBody/content/application~1json/examples/eligible"]}},"schemaId":"components/schemas/AllocateActionRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/requestBody/content/application~1json/examples/reallocate","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/requestBody/content/application~1json/examples/eligible"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/allocate-action","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AllocateActionRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/requestBody/content/application~1json/examples/reallocate","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/requestBody/content/application~1json/examples/eligible"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/allocate-action","href":"allocation/performallocationaction","openApiOperationId":"performAllocationAction","summary":"Reallocate or mark a contract allocation-eligible"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/AllocateActionRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/requestBody/content/application~1json/examples/reallocate","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/requestBody/content/application~1json/examples/eligible"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AllocateActionRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/requestBody/content/application~1json/examples/reallocate","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/requestBody/content/application~1json/examples/eligible"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/missingAction","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/unknownAction","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/missingAction","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/unknownAction","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/missingAction","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/unknownAction","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/missingAction","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/unknownAction","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allocation/performallocationaction"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/allocate-action"},{"label":"Switch the allocation treatment of a contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/allocation/switchallocation","routeSlug":"/other-api/revenue-api-3.0/allocation/switchallocation","metadata":{"seo":{"title":"Switch the allocation treatment of a contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"switchAllocation","name":"Switch the allocation treatment of a contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Switch the allocation treatment of a contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Switches the allocation treatment of the revenue contract and re-runs the allocation of the transaction price in the revenue engine."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract must move between allocation treatments, for example after a contract modification changes how it should be allocated."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SwitchAllocationRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/requestBody/content/application~1json/examples/current","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/requestBody/content/application~1json/examples/explicit"]}},"schemaId":"components/schemas/SwitchAllocationRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/requestBody/content/application~1json/examples/current","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/requestBody/content/application~1json/examples/explicit"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/switch-allocation","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SwitchAllocationRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/requestBody/content/application~1json/examples/current","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/requestBody/content/application~1json/examples/explicit"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/switch-allocation","href":"allocation/switchallocation","openApiOperationId":"switchAllocation","summary":"Switch the allocation treatment of a contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/SwitchAllocationRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/requestBody/content/application~1json/examples/current","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/requestBody/content/application~1json/examples/explicit"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SwitchAllocationRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/requestBody/content/application~1json/examples/current","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/requestBody/content/application~1json/examples/explicit"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/unexpected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/unexpected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/unexpected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/unexpected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/allocation/switchallocation"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/switch-allocation"}],"content":{"contentType":"group","meta":{"name":"Allocation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Allocation","showPageActions":true},{"nodeType":"markdoc","content":"Reallocate the transaction price and change allocation treatment."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue-management/contracts/{rcId}/allocate-action","summary":"Reallocate or mark a contract allocation-eligible","prefix":{"name":"post","color":"post"},"badges":[],"link":"/allocation/performallocationaction","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/switch-allocation","summary":"Switch the allocation treatment of a contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/allocation/switchallocation","deprecated":false}]}]}]}]}},{"type":"group","label":"Lines and POBs","link":"/other-api/revenue-api-3.0/lines-and-pobs","routeSlug":"/other-api/revenue-api-3.0/lines-and-pobs","items":[{"label":"Edit custom attributes of a contract line","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/lines-and-pobs/editrevenuecontractline","routeSlug":"/other-api/revenue-api-3.0/lines-and-pobs/editrevenuecontractline","metadata":{"seo":{"title":"Edit custom attributes of a contract line","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"editRevenueContractLine","name":"Edit custom attributes of a contract line","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit custom attributes of a contract line","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the custom attributes of one revenue contract line: text attributes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atr1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atr60"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", number attributes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"num1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"num15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and date attributes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only the attributes you send change."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correct or enrich reporting attributes (region, segment, product family) on a line after it was collected."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prices, quantities, and transaction dates cannot be changed with this operation."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442},{"name":"lineId","in":"path","schemaId":"schema_30","description":"Revenue contract line ID.","required":true,"example":85922}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EditLineRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/requestBody/content/application~1json/examples/minimal","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/requestBody/content/application~1json/examples/several"]}},"schemaId":"components/schemas/EditLineRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/requestBody/content/application~1json/examples/minimal","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/requestBody/content/application~1json/examples/several"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/lines/{lineId}/edit","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"},{"name":"lineId","in":"path","required":true,"example":85922,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EditLineRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/requestBody/content/application~1json/examples/minimal","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/requestBody/content/application~1json/examples/several"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/lines/{lineId}/edit","href":"lines-and-pobs/editrevenuecontractline","openApiOperationId":"editRevenueContractLine","summary":"Edit custom attributes of a contract line"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/EditLineRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/requestBody/content/application~1json/examples/minimal","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/requestBody/content/application~1json/examples/several"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EditLineRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/requestBody/content/application~1json/examples/minimal","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/requestBody/content/application~1json/examples/several"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/unexpected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/unexpected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/unexpected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/unexpected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/missingComments","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/invalidDate","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/lines-and-pobs/editrevenuecontractline"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/lines/{lineId}/edit"},{"label":"Edit several POBs of a contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/lines-and-pobs/editpobs","routeSlug":"/other-api/revenue-api-3.0/lines-and-pobs/editpobs","metadata":{"seo":{"title":"Edit several POBs of a contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"editPobs","name":"Edit several POBs of a contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit several POBs of a contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the name, POB template, template version, expiry date, and lead line of one or more performance obligations (POBs) of a revenue contract in one call."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reassign POBs to a different POB template (which changes their recognition rules) or correct POB attributes in bulk."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the single-POB operation to edit one POB."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors from the revenue engine for this operation are returned as HTTP 200 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the generic message shown in the examples, not as 4xx/5xx responses."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EditPobsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/requestBody/content/application~1json/examples/bulk"]}},"schemaId":"components/schemas/EditPobsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/requestBody/content/application~1json/examples/bulk"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/pobs/edit","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EditPobsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/requestBody/content/application~1json/examples/bulk"]}},"responseCodes":["200","400","404","500"],"pointer":"/revenue-management/contracts/{rcId}/pobs/edit","href":"lines-and-pobs/editpobs","openApiOperationId":"editPobs","summary":"Edit several POBs of a contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/EditPobsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/requestBody/content/application~1json/examples/bulk"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EditPobsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/requestBody/content/application~1json/examples/bulk"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/engineError"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/engineError"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/missingItemField","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/missingItemField","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/404/content/application~1json/examples/contractNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/404/content/application~1json/examples/contractNotFound"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/500/content/application~1json/examples/systemError"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/engineError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/engineError"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/missingItemField","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/missingItemField","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/404/content/application~1json/examples/contractNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/404/content/application~1json/examples/contractNotFound"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/500/content/application~1json/examples/systemError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/lines-and-pobs/editpobs"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/pobs/edit"},{"label":"Edit one POB of a contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/lines-and-pobs/editpob","routeSlug":"/other-api/revenue-api-3.0/lines-and-pobs/editpob","metadata":{"seo":{"title":"Edit one POB of a contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"editPob","name":"Edit one POB of a contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit one POB of a contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the name, POB template, template version, expiry date, and lead line of one performance obligation (POB)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reassign one POB to a different POB template or correct its attributes."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors from the revenue engine for this operation are returned as HTTP 200 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the generic message shown in the examples, not as 4xx/5xx responses."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442},{"name":"pobId","in":"path","schemaId":"schema_30","description":"Performance obligation (POB) ID.","required":true,"example":156912}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EditPobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/requestBody/content/application~1json/examples/edit"]}},"schemaId":"components/schemas/EditPobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/requestBody/content/application~1json/examples/edit"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/pobs/{pobId}/edit","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"},{"name":"pobId","in":"path","required":true,"example":156912,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EditPobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/requestBody/content/application~1json/examples/edit"]}},"responseCodes":["200","400","404","500"],"pointer":"/revenue-management/contracts/{rcId}/pobs/{pobId}/edit","href":"lines-and-pobs/editpob","openApiOperationId":"editPob","summary":"Edit one POB of a contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/EditPobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/requestBody/content/application~1json/examples/edit"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EditPobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/requestBody/content/application~1json/examples/edit"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/engineError"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/engineError"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/missingField","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/missingField","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/404/content/application~1json/examples/contractNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/404/content/application~1json/examples/contractNotFound"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/500/content/application~1json/examples/systemError"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/engineError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/engineError"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/missingField","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/missingField","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/404/content/application~1json/examples/contractNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/404/content/application~1json/examples/contractNotFound"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/500/content/application~1json/examples/systemError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/lines-and-pobs/editpob"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/pobs/{pobId}/edit"},{"label":"Copy a line into a new manual POB","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/lines-and-pobs/copyline","routeSlug":"/other-api/revenue-api-3.0/lines-and-pobs/copyline","metadata":{"seo":{"title":"Copy a line into a new manual POB","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"copyLine","name":"Copy a line into a new manual POB","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Copy a line into a new manual POB","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new manual POB and line in the revenue contract by copying a source line, optionally overriding its prices, quantity, and document fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a performance obligation that was not in the source data, for example a free service promised outside the order, using an existing line as a template."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CopyLineRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/requestBody/content/application~1json/examples/minimal","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/requestBody/content/application~1json/examples/overrides"]}},"schemaId":"components/schemas/CopyLineRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/requestBody/content/application~1json/examples/minimal","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/requestBody/content/application~1json/examples/overrides"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/copyLn","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CopyLineRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/requestBody/content/application~1json/examples/minimal","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/requestBody/content/application~1json/examples/overrides"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/copyLn","href":"lines-and-pobs/copyline","openApiOperationId":"copyLine","summary":"Copy a line into a new manual POB"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/CopyLineRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/requestBody/content/application~1json/examples/minimal","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/requestBody/content/application~1json/examples/overrides"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CopyLineRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/requestBody/content/application~1json/examples/minimal","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/requestBody/content/application~1json/examples/overrides"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/lines-and-pobs/copyline"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/copyLn"},{"label":"Switch the lead line of a POB","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/lines-and-pobs/switchleadline","routeSlug":"/other-api/revenue-api-3.0/lines-and-pobs/switchleadline","metadata":{"seo":{"title":"Switch the lead line of a POB","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"switchLeadLine","name":"Switch the lead line of a POB","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Switch the lead line of a POB","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Makes a different line the lead line of a performance obligation (POB). The lead line drives POB-level attributes such as dates and release events."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current lead line was cancelled or is no longer representative of the POB."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SwitchLeadLineRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/requestBody/content/application~1json/examples/switch"]}},"schemaId":"components/schemas/SwitchLeadLineRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/requestBody/content/application~1json/examples/switch"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/switch-lead-line","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SwitchLeadLineRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/requestBody/content/application~1json/examples/switch"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/switch-lead-line","href":"lines-and-pobs/switchleadline","openApiOperationId":"switchLeadLine","summary":"Switch the lead line of a POB"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/SwitchLeadLineRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/requestBody/content/application~1json/examples/switch"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SwitchLeadLineRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/requestBody/content/application~1json/examples/switch"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/lines-and-pobs/switchleadline"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/switch-lead-line"},{"label":"Move a POB to a different derived POB","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/lines-and-pobs/movepob","routeSlug":"/other-api/revenue-api-3.0/lines-and-pobs/movepob","metadata":{"seo":{"title":"Move a POB to a different derived POB","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"movePob","name":"Move a POB to a different derived POB","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Move a POB to a different derived POB","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Changes the POB assignment of a performance obligation, or of one of its lines, to a different derived POB."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lines were grouped into the wrong POB and must be reclassified."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lineId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to move a single line."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors from the revenue engine for this operation are returned as HTTP 200 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the generic message shown in the examples, not as 4xx/5xx responses."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MovePobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/requestBody/content/application~1json/examples/move","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/requestBody/content/application~1json/examples/line"]}},"schemaId":"components/schemas/MovePobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/requestBody/content/application~1json/examples/move","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/requestBody/content/application~1json/examples/line"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/move-pob","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MovePobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/requestBody/content/application~1json/examples/move","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/requestBody/content/application~1json/examples/line"]}},"responseCodes":["200","400","404","500"],"pointer":"/revenue-management/contracts/{rcId}/move-pob","href":"lines-and-pobs/movepob","openApiOperationId":"movePob","summary":"Move a POB to a different derived POB"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/MovePobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/requestBody/content/application~1json/examples/move","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/requestBody/content/application~1json/examples/line"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MovePobRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/requestBody/content/application~1json/examples/move","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/requestBody/content/application~1json/examples/line"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/engineError"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/engineError"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/invalidBookHeader"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/invalidBookHeader"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/404/content/application~1json/examples/contractNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/404/content/application~1json/examples/contractNotFound"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/500/content/application~1json/examples/systemError"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/engineError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/engineError"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/invalidBookHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/invalidBookHeader"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/404/content/application~1json/examples/contractNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/404/content/application~1json/examples/contractNotFound"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/500/content/application~1json/examples/systemError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/lines-and-pobs/movepob"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/move-pob"}],"content":{"contentType":"group","meta":{"name":"Lines and POBs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lines and POBs","showPageActions":true},{"nodeType":"markdoc","content":"Edit lines and POBs, copy lines, switch lead lines, and move POBs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue-management/contracts/{rcId}/lines/{lineId}/edit","summary":"Edit custom attributes of a contract line","prefix":{"name":"post","color":"post"},"badges":[],"link":"/lines-and-pobs/editrevenuecontractline","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/pobs/edit","summary":"Edit several POBs of a contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/lines-and-pobs/editpobs","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/pobs/{pobId}/edit","summary":"Edit one POB of a contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/lines-and-pobs/editpob","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/copyLn","summary":"Copy a line into a new manual POB","prefix":{"name":"post","color":"post"},"badges":[],"link":"/lines-and-pobs/copyline","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/switch-lead-line","summary":"Switch the lead line of a POB","prefix":{"name":"post","color":"post"},"badges":[],"link":"/lines-and-pobs/switchleadline","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/move-pob","summary":"Move a POB to a different derived POB","prefix":{"name":"post","color":"post"},"badges":[],"link":"/lines-and-pobs/movepob","deprecated":false}]}]}]}]}},{"type":"group","label":"Contract Grouping","link":"/other-api/revenue-api-3.0/contract-grouping","routeSlug":"/other-api/revenue-api-3.0/contract-grouping","items":[{"label":"Link contracts into a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/linkcontracts","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/linkcontracts","metadata":{"seo":{"title":"Link contracts into a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"linkContracts","name":"Link contracts into a revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Link contracts into a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merges other revenue contracts into the contract in the path."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contracts that belong together (for example a sale and its later add-on) were created separately and must be allocated together."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract version is checked with optimistic locking. The revenue engine validates that the contract and the referenced objects are eligible."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/requestBody/content/application~1json/examples/example"]}},"schemaId":"components/schemas/LinkRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/requestBody/content/application~1json/examples/example"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/link-rc","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LinkRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/requestBody/content/application~1json/examples/example"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/link-rc","href":"contract-grouping/linkcontracts","openApiOperationId":"linkContracts","summary":"Link contracts into a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/LinkRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/requestBody/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/requestBody/content/application~1json/examples/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-grouping/linkcontracts"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/link-rc"},{"label":"Link POBs into a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/linkpobs","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/linkpobs","metadata":{"seo":{"title":"Link POBs into a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"linkPobs","name":"Link POBs into a revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Link POBs into a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Moves the given POBs from other contracts into the contract in the path."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A POB was grouped into the wrong contract."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract version is checked with optimistic locking. The revenue engine validates that the contract and the referenced objects are eligible."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkPobsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/requestBody/content/application~1json/examples/example"]}},"schemaId":"components/schemas/LinkPobsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/requestBody/content/application~1json/examples/example"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/pobs/link","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LinkPobsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/requestBody/content/application~1json/examples/example"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/pobs/link","href":"contract-grouping/linkpobs","openApiOperationId":"linkPobs","summary":"Link POBs into a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/LinkPobsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/requestBody/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkPobsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/requestBody/content/application~1json/examples/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-grouping/linkpobs"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/pobs/link"},{"label":"Link lines into a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/linklines","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/linklines","metadata":{"seo":{"title":"Link lines into a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"linkLines","name":"Link lines into a revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Link lines into a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Links document lines into the contract, attaching them to a POB ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcPobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or grouping them under a lead line ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"leadLineId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific lines must join this contract."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract version is checked with optimistic locking. The revenue engine validates that the contract and the referenced objects are eligible."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkLinesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/requestBody/content/application~1json/examples/example","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/requestBody/content/application~1json/examples/toLeadLine"]}},"schemaId":"components/schemas/LinkLinesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/requestBody/content/application~1json/examples/example","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/requestBody/content/application~1json/examples/toLeadLine"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/lines/link","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LinkLinesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/requestBody/content/application~1json/examples/example","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/requestBody/content/application~1json/examples/toLeadLine"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/lines/link","href":"contract-grouping/linklines","openApiOperationId":"linkLines","summary":"Link lines into a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/LinkLinesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/requestBody/content/application~1json/examples/example","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/requestBody/content/application~1json/examples/toLeadLine"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkLinesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/requestBody/content/application~1json/examples/example","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/requestBody/content/application~1json/examples/toLeadLine"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-grouping/linklines"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/lines/link"},{"label":"Link charges into a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/linkcharges","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/linkcharges","metadata":{"seo":{"title":"Link charges into a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"linkCharges","name":"Link charges into a revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Link charges into a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Links all lines of the given Zuora Billing charges into the contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A subscription charge was grouped into a different contract."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract version is checked with optimistic locking. The revenue engine validates that the contract and the referenced objects are eligible."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkChargesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/requestBody/content/application~1json/examples/example"]}},"schemaId":"components/schemas/LinkChargesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/requestBody/content/application~1json/examples/example"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/charges/link","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LinkChargesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/requestBody/content/application~1json/examples/example"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/charges/link","href":"contract-grouping/linkcharges","openApiOperationId":"linkCharges","summary":"Link charges into a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/LinkChargesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/requestBody/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkChargesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/requestBody/content/application~1json/examples/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-grouping/linkcharges"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/charges/link"},{"label":"Link subscriptions into a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/linksubscriptions","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/linksubscriptions","metadata":{"seo":{"title":"Link subscriptions into a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"linkSubscriptions","name":"Link subscriptions into a revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Link subscriptions into a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Links all lines of the given subscriptions into the contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All lines of a subscription must be accounted for in this contract."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract version is checked with optimistic locking. The revenue engine validates that the contract and the referenced objects are eligible."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkSubscriptionsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/requestBody/content/application~1json/examples/example"]}},"schemaId":"components/schemas/LinkSubscriptionsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/requestBody/content/application~1json/examples/example"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/subscriptions/link","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LinkSubscriptionsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/requestBody/content/application~1json/examples/example"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/subscriptions/link","href":"contract-grouping/linksubscriptions","openApiOperationId":"linkSubscriptions","summary":"Link subscriptions into a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/LinkSubscriptionsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/requestBody/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LinkSubscriptionsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/requestBody/content/application~1json/examples/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-grouping/linksubscriptions"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/subscriptions/link"},{"label":"Delink a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/delinkcontract","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/delinkcontract","metadata":{"seo":{"title":"Delink a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delinkContract","name":"Delink a revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delink a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Undoes a contract-level link, so contracts that were merged into this one separate again."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contracts were merged by mistake."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract version is checked with optimistic locking. The revenue engine validates that the contract and the referenced objects are eligible."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DelinkRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/requestBody/content/application~1json/examples/example"]}},"schemaId":"components/schemas/DelinkRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/requestBody/content/application~1json/examples/example"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/delink-rc","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DelinkRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/requestBody/content/application~1json/examples/example"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/delink-rc","href":"contract-grouping/delinkcontract","openApiOperationId":"delinkContract","summary":"Delink a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/DelinkRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/requestBody/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DelinkRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/requestBody/content/application~1json/examples/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-grouping/delinkcontract"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/delink-rc"},{"label":"Delink POBs from a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/delinkpobs","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/delinkpobs","metadata":{"seo":{"title":"Delink POBs from a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delinkPobs","name":"Delink POBs from a revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delink POBs from a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes the given POBs, and their lines, from the contract so they regroup into separate contracts."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A POB does not belong in this contract."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract version is checked with optimistic locking. The revenue engine validates that the contract and the referenced objects are eligible."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DelinkPobsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/requestBody/content/application~1json/examples/example"]}},"schemaId":"components/schemas/DelinkPobsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/requestBody/content/application~1json/examples/example"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/pobs/delink","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DelinkPobsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/requestBody/content/application~1json/examples/example"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/pobs/delink","href":"contract-grouping/delinkpobs","openApiOperationId":"delinkPobs","summary":"Delink POBs from a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/DelinkPobsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/requestBody/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DelinkPobsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/requestBody/content/application~1json/examples/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-grouping/delinkpobs"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/pobs/delink"},{"label":"Delink lines from a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/delinklines","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/delinklines","metadata":{"seo":{"title":"Delink lines from a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delinkLines","name":"Delink lines from a revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delink lines from a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes specific document lines from the contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A line does not belong in this contract."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract version is checked with optimistic locking. The revenue engine validates that the contract and the referenced objects are eligible."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DelinkLinesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/requestBody/content/application~1json/examples/example"]}},"schemaId":"components/schemas/DelinkLinesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/requestBody/content/application~1json/examples/example"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/lines/delink","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DelinkLinesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/requestBody/content/application~1json/examples/example"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/lines/delink","href":"contract-grouping/delinklines","openApiOperationId":"delinkLines","summary":"Delink lines from a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/DelinkLinesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/requestBody/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DelinkLinesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/requestBody/content/application~1json/examples/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-grouping/delinklines"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/lines/delink"},{"label":"Delink charges from a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/delinkcharges","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/delinkcharges","metadata":{"seo":{"title":"Delink charges from a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delinkCharges","name":"Delink charges from a revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delink charges from a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes all lines of the given Zuora Billing charges from the contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A charge must be accounted for separately."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract version is checked with optimistic locking. The revenue engine validates that the contract and the referenced objects are eligible."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DelinkChargesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/requestBody/content/application~1json/examples/example"]}},"schemaId":"components/schemas/DelinkChargesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/requestBody/content/application~1json/examples/example"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/charges/delink","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DelinkChargesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/requestBody/content/application~1json/examples/example"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/charges/delink","href":"contract-grouping/delinkcharges","openApiOperationId":"delinkCharges","summary":"Delink charges from a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/DelinkChargesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/requestBody/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DelinkChargesRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/requestBody/content/application~1json/examples/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-grouping/delinkcharges"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/charges/delink"},{"label":"Delink subscriptions from a revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/delinksubscriptions","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/delinksubscriptions","metadata":{"seo":{"title":"Delink subscriptions from a revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"delinkSubscriptions","name":"Delink subscriptions from a revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delink subscriptions from a revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes all lines of the given subscriptions from the contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A subscription must be accounted for separately."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract version is checked with optimistic locking. The revenue engine validates that the contract and the referenced objects are eligible."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DelinkSubscriptionsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/requestBody/content/application~1json/examples/example"]}},"schemaId":"components/schemas/DelinkSubscriptionsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/requestBody/content/application~1json/examples/example"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/subscriptions/delink","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DelinkSubscriptionsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/requestBody/content/application~1json/examples/example"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/subscriptions/delink","href":"contract-grouping/delinksubscriptions","openApiOperationId":"delinkSubscriptions","summary":"Delink subscriptions from a revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/DelinkSubscriptionsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/requestBody/content/application~1json/examples/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DelinkSubscriptionsRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/requestBody/content/application~1json/examples/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/emptyList","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-grouping/delinksubscriptions"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/subscriptions/delink"},{"label":"Undo a delink","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/undodelink","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/undodelink","metadata":{"seo":{"title":"Undo a delink","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"undoDelink","name":"Undo a delink","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Undo a delink","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reverses a previous delink on the revenue contract, restoring the contracts, POBs, or lines that were split off."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A delink was done by mistake and must be reverted."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UndoDelinkRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/requestBody/content/application~1json/examples/undo"]}},"schemaId":"components/schemas/UndoDelinkRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/requestBody/content/application~1json/examples/undo"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/undoDelink","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UndoDelinkRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/requestBody/content/application~1json/examples/undo"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/undoDelink","href":"contract-grouping/undodelink","openApiOperationId":"undoDelink","summary":"Undo a delink"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/UndoDelinkRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/requestBody/content/application~1json/examples/undo"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UndoDelinkRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/requestBody/content/application~1json/examples/undo"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/missingVersion","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/missingVersion","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/missingVersion","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/missingVersion","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-grouping/undodelink"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/undoDelink"},{"label":"Create a manual revenue contract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/contract-grouping/createmanualrevenuecontract","routeSlug":"/other-api/revenue-api-3.0/contract-grouping/createmanualrevenuecontract","metadata":{"seo":{"title":"Create a manual revenue contract","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createManualRevenueContract","name":"Create a manual revenue contract","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1create-manual/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a manual revenue contract","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new revenue contract by manually grouping whole contracts, or selected POBs and document lines."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Automatic grouping rules did not produce the contract you need, for example lines from different orders must be accounted for as one contract."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"retain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a POB to keep it in its source contract as well."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation has no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter. The revenue engine validates that the selected objects are eligible. Every POB entry must include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1create-manual/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateManualRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/requestBody/content/application~1json/examples/fromContracts","paths/~1revenue-management~1contracts~1create-manual/post/requestBody/content/application~1json/examples/fromPobs"]}},"schemaId":"components/schemas/CreateManualRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/requestBody/content/application~1json/examples/fromContracts","paths/~1revenue-management~1contracts~1create-manual/post/requestBody/content/application~1json/examples/fromPobs"],"pointer":"/paths/~1revenue-management~1contracts~1create-manual/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/create-manual","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateManualRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/requestBody/content/application~1json/examples/fromContracts","paths/~1revenue-management~1contracts~1create-manual/post/requestBody/content/application~1json/examples/fromPobs"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/create-manual","href":"contract-grouping/createmanualrevenuecontract","openApiOperationId":"createManualRevenueContract","summary":"Create a manual revenue contract"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/CreateManualRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/requestBody/content/application~1json/examples/fromContracts","paths/~1revenue-management~1contracts~1create-manual/post/requestBody/content/application~1json/examples/fromPobs"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateManualRcRequest","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/requestBody/content/application~1json/examples/fromContracts","paths/~1revenue-management~1contracts~1create-manual/post/requestBody/content/application~1json/examples/fromPobs"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1create-manual/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1create-manual/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1create-manual/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1create-manual/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1create-manual/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1create-manual/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/contract-grouping/createmanualrevenuecontract"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/create-manual"}],"content":{"contentType":"group","meta":{"name":"Contract Grouping"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Contract Grouping","showPageActions":true},{"nodeType":"markdoc","content":"Link, delink, undo delink, and manually create revenue contracts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue-management/contracts/{rcId}/link-rc","summary":"Link contracts into a revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contract-grouping/linkcontracts","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/pobs/link","summary":"Link POBs into a revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contract-grouping/linkpobs","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/lines/link","summary":"Link lines into a revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contract-grouping/linklines","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/charges/link","summary":"Link charges into a revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contract-grouping/linkcharges","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/subscriptions/link","summary":"Link subscriptions into a revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contract-grouping/linksubscriptions","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/delink-rc","summary":"Delink a revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contract-grouping/delinkcontract","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/pobs/delink","summary":"Delink POBs from a revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contract-grouping/delinkpobs","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/lines/delink","summary":"Delink lines from a revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contract-grouping/delinklines","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/charges/delink","summary":"Delink charges from a revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contract-grouping/delinkcharges","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/subscriptions/delink","summary":"Delink subscriptions from a revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contract-grouping/delinksubscriptions","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/undoDelink","summary":"Undo a delink","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contract-grouping/undodelink","deprecated":false},{"title":"/revenue-management/contracts/create-manual","summary":"Create a manual revenue contract","prefix":{"name":"post","color":"post"},"badges":[],"link":"/contract-grouping/createmanualrevenuecontract","deprecated":false}]}]}]}]}},{"type":"group","label":"Variable Consideration","link":"/other-api/revenue-api-3.0/variable-consideration","routeSlug":"/other-api/revenue-api-3.0/variable-consideration","items":[{"label":"List variable consideration types for a line","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/variable-consideration/listvariableconsiderationtypes","routeSlug":"/other-api/revenue-api-3.0/variable-consideration/listvariableconsiderationtypes","metadata":{"seo":{"title":"List variable consideration types for a line","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listVariableConsiderationTypes","name":"List variable consideration types for a line","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List variable consideration types for a line","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the variable consideration (VC) types that can still be applied to a line: enabled types that are configured on the line's POB template and not already applied to the line."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Before applying variable consideration, to find a valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vcTypeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the lead line of the POB as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcLineId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; other lines return an empty list. An unknown contract or line also returns an empty list. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcLineId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required; omitting it returns HTTP 500."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"rcLineId","in":"query","schemaId":"schema_30","description":"Revenue contract line ID (the POB lead line).","required":true,"example":85922},{"name":"vcRuleType","in":"query","schemaId":"schema_68","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only return types with this rule type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"E"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" estimate, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" actuals, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set."},"children":[]}]}]}]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenue-management/contracts/{rcId}/vc-types","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[{"name":"rcLineId","in":"query","required":true,"example":85922,"schemaId":"schema_30"},{"name":"vcRuleType","in":"query","required":false,"schemaId":"schema_68"}],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/revenue-management/contracts/{rcId}/vc-types","href":"variable-consideration/listvariableconsiderationtypes","openApiOperationId":"listVariableConsiderationTypes","summary":"List variable consideration types for a line"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Applicable variable consideration types, sorted by name. Empty when none apply.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_69","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/200/content/application~1json/examples/types","paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/200/content/application~1json/examples/none"]}},"schemaId":"schema_69","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/200/content/application~1json/examples/types","paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/200/content/application~1json/examples/none"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":"Invalid book header.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/400/content/application~1json/examples/invalidBookHeader"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/400/content/application~1json/examples/invalidBookHeader"]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcLineId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is missing or not numeric, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric, or an unexpected failure occurred."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/500/content/application~1json/examples/systemError"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_69","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/200/content/application~1json/examples/types","paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/200/content/application~1json/examples/none"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_69","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/200/content/application~1json/examples/types","paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/200/content/application~1json/examples/none"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/400/content/application~1json/examples/invalidBookHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/400/content/application~1json/examples/invalidBookHeader"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/500/content/application~1json/examples/systemError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variable-consideration/listvariableconsiderationtypes"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/vc-types"},{"label":"Apply variable consideration to a line","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/variable-consideration/applyvariableconsideration","routeSlug":"/other-api/revenue-api-3.0/variable-consideration/applyvariableconsideration","metadata":{"seo":{"title":"Apply variable consideration to a line","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"applyVariableConsideration","name":"Apply variable consideration to a line","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply variable consideration to a line","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies variable consideration (for example a rebate, discount, or penalty) of a given type to a revenue contract line, as an amount or a percentage. This creates a line price adjustment that changes the transaction price and flows into allocation and revenue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Record an estimated ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"E"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), actual ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or set ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") variable consideration that is not in the source data."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dryRun: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" first to preview the effect without saving."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vcTypeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /revenue-management/contracts/{rcId}/vc-types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyVcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/estimate","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/percent","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/dryRun"]}},"schemaId":"components/schemas/ApplyVcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/estimate","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/percent","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/dryRun"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/apply-vc","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplyVcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/estimate","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/percent","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/dryRun"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/apply-vc","href":"variable-consideration/applyvariableconsideration","openApiOperationId":"applyVariableConsideration","summary":"Apply variable consideration to a line"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/ApplyVcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/estimate","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/percent","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/dryRun"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyVcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/estimate","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/percent","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/dryRun"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplyVcResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/preview","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/unexpected"]}},"schemaId":"components/schemas/ApplyVcResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/preview","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/unexpected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidRuleType","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidApplyType","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidRuleType","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidApplyType","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ApplyVcResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/preview","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/unexpected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApplyVcResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/applied","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/preview","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/unexpected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidRuleType","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidApplyType","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidRuleType","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidApplyType","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variable-consideration/applyvariableconsideration"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/apply-vc"},{"label":"Expire variable consideration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/variable-consideration/expirevariableconsideration","routeSlug":"/other-api/revenue-api-3.0/variable-consideration/expirevariableconsideration","metadata":{"seo":{"title":"Expire variable consideration","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"expireVariableConsideration","name":"Expire variable consideration","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Expire variable consideration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Expires, for the given amount, a variable consideration previously applied to a line, for example when an unused rebate or credit lapses."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The estimate behind a variable consideration will not be realized."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcLineAdjustmentRecords"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned by apply-vc as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcLinePriceAdjustmentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExpireVcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/requestBody/content/application~1json/examples/expire"]}},"schemaId":"components/schemas/ExpireVcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/requestBody/content/application~1json/examples/expire"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/expire-vc","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExpireVcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/requestBody/content/application~1json/examples/expire"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/expire-vc","href":"variable-consideration/expirevariableconsideration","openApiOperationId":"expireVariableConsideration","summary":"Expire variable consideration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/ExpireVcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/requestBody/content/application~1json/examples/expire"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExpireVcRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/requestBody/content/application~1json/examples/expire"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/unexpected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/unexpected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/unexpected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/unexpected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/404/content/application~1json/examples/contractNotFound","paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/variable-consideration/expirevariableconsideration"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/expire-vc"}],"content":{"contentType":"group","meta":{"name":"Variable Consideration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Variable Consideration","showPageActions":true},{"nodeType":"markdoc","content":"List, apply, and expire variable consideration."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue-management/contracts/{rcId}/vc-types","summary":"List variable consideration types for a line","prefix":{"name":"get","color":"get"},"badges":[],"link":"/variable-consideration/listvariableconsiderationtypes","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/apply-vc","summary":"Apply variable consideration to a line","prefix":{"name":"post","color":"post"},"badges":[],"link":"/variable-consideration/applyvariableconsideration","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/expire-vc","summary":"Expire variable consideration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/variable-consideration/expirevariableconsideration","deprecated":false}]}]}]}]}},{"type":"group","label":"Impairment","link":"/other-api/revenue-api-3.0/impairment","routeSlug":"/other-api/revenue-api-3.0/impairment","items":[{"label":"Apply impairment to contract lines","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/impairment/applyimpairment","routeSlug":"/other-api/revenue-api-3.0/impairment/applyimpairment","metadata":{"seo":{"title":"Apply impairment to contract lines","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"applyImpairment","name":"Apply impairment to contract lines","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Apply impairment to contract lines","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Flags one or more revenue contract lines with an impairment type, so the revenue engine applies the matching impairment accounting."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A contract modification or credit event requires impairment accounting for specific lines."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Impairment types: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contract impairment, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" new POB ratable, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" R and R within SSP, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors from the revenue engine for this operation are returned as HTTP 200 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the generic message shown in the examples, not as 4xx/5xx responses."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyImpairmentRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/requestBody/content/application~1json/examples/impair"]}},"schemaId":"components/schemas/ApplyImpairmentRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/requestBody/content/application~1json/examples/impair"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/apply-impairment","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ApplyImpairmentRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/requestBody/content/application~1json/examples/impair"]}},"responseCodes":["200","400","404","500"],"pointer":"/revenue-management/contracts/{rcId}/apply-impairment","href":"impairment/applyimpairment","openApiOperationId":"applyImpairment","summary":"Apply impairment to contract lines"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/ApplyImpairmentRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/requestBody/content/application~1json/examples/impair"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ApplyImpairmentRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/requestBody/content/application~1json/examples/impair"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/engineError"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/engineError"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/emptyLines","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/missingLineFields","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/invalidBookHeader"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/emptyLines","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/missingLineFields","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/invalidBookHeader"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/404/content/application~1json/examples/contractNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/404/content/application~1json/examples/contractNotFound"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/500/content/application~1json/examples/systemError"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/engineError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/engineError"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/emptyLines","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/missingLineFields","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/invalidBookHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/emptyLines","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/missingLineFields","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/objectVersionUnresolved","paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/invalidBookHeader"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/404/content/application~1json/examples/contractNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/404/content/application~1json/examples/contractNotFound"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/500/content/application~1json/examples/systemError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/impairment/applyimpairment"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/apply-impairment"}],"content":{"contentType":"group","meta":{"name":"Impairment"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Impairment","showPageActions":true},{"nodeType":"markdoc","content":"Apply impairment to contract lines."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue-management/contracts/{rcId}/apply-impairment","summary":"Apply impairment to contract lines","prefix":{"name":"post","color":"post"},"badges":[],"link":"/impairment/applyimpairment","deprecated":false}]}]}]}]}},{"type":"group","label":"Usage","link":"/other-api/revenue-api-3.0/usage","routeSlug":"/other-api/revenue-api-3.0/usage","items":[{"label":"Edit usage records","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/usage/editusage","routeSlug":"/other-api/revenue-api-3.0/usage/editusage","metadata":{"seo":{"title":"Edit usage records","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"editUsage","name":"Edit usage records","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Edit usage records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the quantity, usage amount, unit price, or usage attributes of one or more usage records that feed usage-based revenue. Only the fields you send change."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage data loaded into Zuora Revenue was wrong and must be corrected without reloading it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage records are identified by their own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; the contract in the path is not checked."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EditUsageRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/requestBody/content/application~1json/examples/edit"]}},"schemaId":"components/schemas/EditUsageRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/requestBody/content/application~1json/examples/edit"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/edit-usage","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EditUsageRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/requestBody/content/application~1json/examples/edit"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/edit-usage","href":"usage/editusage","openApiOperationId":"editUsage","summary":"Edit usage records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/EditUsageRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/requestBody/content/application~1json/examples/edit"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EditUsageRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/requestBody/content/application~1json/examples/edit"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/emptyItems","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/invalidId","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/emptyItems","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/invalidId","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/emptyItems","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/invalidId","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/emptyItems","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/invalidId","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usage/editusage"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/edit-usage"},{"label":"Cancel a usage record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/usage/cancelusage","routeSlug":"/other-api/revenue-api-3.0/usage/cancelusage","metadata":{"seo":{"title":"Cancel a usage record","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelUsage","name":"Cancel a usage record","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a usage record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels a usage record so it no longer contributes to usage-based revenue."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A usage record was loaded in error or was reversed in the source system."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contract in the path is not checked."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelUsageRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/requestBody/content/application~1json/examples/cancel"]}},"schemaId":"components/schemas/CancelUsageRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/requestBody/content/application~1json/examples/cancel"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/usage-cancel","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CancelUsageRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/requestBody/content/application~1json/examples/cancel"]}},"responseCodes":["200","400","403","404","409","429","500","503","504"],"pointer":"/revenue-management/contracts/{rcId}/usage-cancel","href":"usage/cancelusage","openApiOperationId":"cancelUsage","summary":"Cancel a usage record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/CancelUsageRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/requestBody/content/application~1json/examples/cancel"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelUsageRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/requestBody/content/application~1json/examples/cancel"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/200/content/application~1json/examples/rejected"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/200/content/application~1json/examples/rejected"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/missingId","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/invalidId","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/engineRejected"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/missingId","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/invalidId","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/engineRejected"]},{"code":"403","description":"The revenue engine denied the action for the caller.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/403/content/application~1json/examples/permissionDenied"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/403/content/application~1json/examples/permissionDenied"]},{"code":"404","description":"The revenue contract, or an object referenced in the request, was not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/404/content/application~1json/examples/engineNotFound"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/404/content/application~1json/examples/engineNotFound"]},{"code":"409","description":"The action conflicts with a concurrent change to the contract. Read the contract again and retry.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/409/content/application~1json/examples/conflict"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/409/content/application~1json/examples/conflict"]},{"code":"429","description":"The revenue engine is temporarily out of capacity. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/429/content/application~1json/examples/resourceExhausted"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/429/content/application~1json/examples/resourceExhausted"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/500/content/application~1json/examples/systemError"]},{"code":"503","description":"The revenue engine is temporarily unavailable. Retry with exponential backoff.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/503/content/application~1json/examples/unavailable"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/503/content/application~1json/examples/unavailable"]},{"code":"504","description":"The revenue engine did not respond in time. Check the contract before retrying, because the action may have completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/504/content/application~1json/examples/timeout"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/504/content/application~1json/examples/timeout"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/200/content/application~1json/examples/rejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/200/content/application~1json/examples/rejected"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/missingId","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/invalidId","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/engineRejected"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/missingId","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/invalidId","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/invalidBookHeader","paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/engineRejected"]}}},{"code":"403","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/403/content/application~1json/examples/permissionDenied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/403/content/application~1json/examples/permissionDenied"]}}},{"code":"404","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/404/content/application~1json/examples/engineNotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/404/content/application~1json/examples/engineNotFound"]}}},{"code":"409","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/409/content/application~1json/examples/conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/409/content/application~1json/examples/conflict"]}}},{"code":"429","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/429/content/application~1json/examples/resourceExhausted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/429/content/application~1json/examples/resourceExhausted"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/500/content/application~1json/examples/systemError"]}}},{"code":"503","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/503/content/application~1json/examples/unavailable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/503/content/application~1json/examples/unavailable"]}}},{"code":"504","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/504/content/application~1json/examples/timeout"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/504/content/application~1json/examples/timeout"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/usage/cancelusage"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/usage-cancel"}],"content":{"contentType":"group","meta":{"name":"Usage"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Usage","showPageActions":true},{"nodeType":"markdoc","content":"Correct and cancel usage records."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue-management/contracts/{rcId}/edit-usage","summary":"Edit usage records","prefix":{"name":"post","color":"post"},"badges":[],"link":"/usage/editusage","deprecated":false},{"title":"/revenue-management/contracts/{rcId}/usage-cancel","summary":"Cancel a usage record","prefix":{"name":"post","color":"post"},"badges":[],"link":"/usage/cancelusage","deprecated":false}]}]}]}]}},{"type":"group","label":"Billing","link":"/other-api/revenue-api-3.0/billing","routeSlug":"/other-api/revenue-api-3.0/billing","items":[{"label":"Void a billing document","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/billing/voidbilling","routeSlug":"/other-api/revenue-api-3.0/billing/voidbilling","metadata":{"seo":{"title":"Void a billing document","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"voidBilling","name":"Void a billing document","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Void a billing document","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Voids a billing document (invoice or credit memo) on the revenue contract, reversing its billed amounts from the contract's billing, contract asset, and contract liability balances."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A billing document was voided or issued in error in the billing system and Zuora Revenue must reflect it."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors from the revenue engine for this operation are returned as HTTP 200 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the generic message shown in the examples, not as 4xx/5xx responses. The contract in the path is validated by the revenue engine."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VoidBillingRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/requestBody/content/application~1json/examples/void"]}},"schemaId":"components/schemas/VoidBillingRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/requestBody/content/application~1json/examples/void"],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/void-billing","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VoidBillingRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/requestBody/content/application~1json/examples/void"]}},"responseCodes":["200","400","500"],"pointer":"/revenue-management/contracts/{rcId}/void-billing","href":"billing/voidbilling","openApiOperationId":"voidBilling","summary":"Void a billing document"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"schemaId":"components/schemas/VoidBillingRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/requestBody/content/application~1json/examples/void"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VoidBillingRequest","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/requestBody/content/application~1json/examples/void"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/engineError"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/engineError"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/invalidBookHeader"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/invalidBookHeader"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/500/content/application~1json/examples/systemError"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/engineError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/engineError"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/invalidBookHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/missingFields","paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/malformedBody","paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/invalidBookHeader"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/500/content/application~1json/examples/systemError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing/voidbilling"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/void-billing"}],"content":{"contentType":"group","meta":{"name":"Billing"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Billing","showPageActions":true},{"nodeType":"markdoc","content":"Void billing documents on a contract."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue-management/contracts/{rcId}/void-billing","summary":"Void a billing document","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing/voidbilling","deprecated":false}]}]}]}]}},{"type":"group","label":"Forecast","link":"/other-api/revenue-api-3.0/forecast","routeSlug":"/other-api/revenue-api-3.0/forecast","items":[{"label":"Generate the revenue forecast","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/other-api/revenue-api-3.0/forecast/generateforecast","routeSlug":"/other-api/revenue-api-3.0/forecast/generateforecast","metadata":{"seo":{"title":"Generate the revenue forecast","description":"Purpose"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateForecast","name":"Generate the revenue forecast","isWebhook":false,"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate the revenue forecast","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Purpose"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regenerates the forecast revenue schedules of the revenue contract in real time."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When to use"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After a change to the contract (for example an edit or a hold release) when you need the forecast to be current immediately, without waiting for the scheduled job."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Behavior notes"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No request body is needed. Errors from the revenue engine for this operation are returned as HTTP 200 with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the generic message shown in the examples, not as 4xx/5xx responses."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"rcId","in":"path","schemaId":"schema_30","description":"Revenue contract ID.","required":true,"example":111442}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-REV-BOOK-ID","in":"header","schemaId":"schema_63","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue book to work in. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books."},"children":[]}]}]}],"example":1},{"name":"Zuora-Request-Id","in":"header","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional correlation ID, echoed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header."},"children":[]}]}]}],"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11"}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenue-management/contracts/{rcId}/generate-forecast","servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"parameters":{"path":[{"name":"rcId","in":"path","required":true,"example":111442,"schemaId":"schema_30"}],"query":[],"querystring":[],"header":[{"name":"X-REV-BOOK-ID","in":"header","required":false,"example":1,"schemaId":"schema_63"},{"name":"Zuora-Request-Id","in":"header","required":false,"example":"b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11","schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","500"],"pointer":"/revenue-management/contracts/{rcId}/generate-forecast","href":"forecast/generateforecast","openApiOperationId":"generateForecast","summary":"Generate the revenue forecast"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://one.zuora.com/revenue/services/v1","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Processed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the action completed; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means a business rule rejected it and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explains why."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/engineError"]}},"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/engineError"],"headers":{"traceId":{"$ref":"#/components/headers/TraceId"}},"headerSchemaId":"schema_65"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid request. Each problem is listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/400/content/application~1json/examples/invalidBookHeader"]}},"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/400/content/application~1json/examples/invalidBookHeader"]},{"code":"500","description":"Unexpected failure inside Zuora Revenue. This status is also returned when a path ID is not numeric. Do not retry the same request unchanged; contact Zuora Global Support if it persists.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/500/content/application~1json/examples/systemError"]}},"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/500/content/application~1json/examples/systemError"]}],"pointer":"/paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/engineError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ManualActionResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/done","paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/rejected","paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/engineError"]}}},{"code":"400","schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/400/content/application~1json/examples/invalidBookHeader"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClientErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/400/content/application~1json/examples/invalidBookHeader"]}}},{"code":"500","schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/500/content/application~1json/examples/systemError"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServerErrorResponse","exampleIds":["paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/500/content/application~1json/examples/systemError"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/forecast/generateforecast"}],"panels":[]}]},"httpPath":"/revenue-management/contracts/{rcId}/generate-forecast"}],"content":{"contentType":"group","meta":{"name":"Forecast"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Forecast","showPageActions":true},{"nodeType":"markdoc","content":"Regenerate forecast revenue schedules."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenue-management/contracts/{rcId}/generate-forecast","summary":"Generate the revenue forecast","prefix":{"name":"post","color":"post"},"badges":[],"link":"/forecast/generateforecast","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/JobStatusResponse":{"id":"components/schemas/JobStatusResponse","kind":"json-schema","title":"JobStatusResponse","data":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/JobStatus"},"success":{"type":"boolean"}}}},"components/schemas/JobStatus":{"id":"components/schemas/JobStatus","kind":"json-schema","title":"JobStatus","data":{"type":"object","properties":{"actual_start_date":{"type":"string","format":"datetime"},"crtd_by":{"type":"string"},"crtd_dt":{"type":"string","format":"datetime"},"error_message":{"type":"string"},"id":{"type":"integer"},"sec_atr_val":{"type":"integer"},"status":{"type":"string"},"updt_dt":{"type":"string","format":"datetime"}}}},"components/schemas/SubmitJobFailureResponse":{"id":"components/schemas/SubmitJobFailureResponse","kind":"json-schema","title":"SubmitJobFailureResponse","data":{"type":"object","properties":{"error":{"type":"string","enum":["OrgId does not match the Org assigned to the role","This Program is not supported at the moment"]},"success":{"type":"boolean"}}}},"components/schemas/SubmitJobRequest":{"id":"components/schemas/SubmitJobRequest","kind":"json-schema","title":"SubmitJobRequest","data":{"type":"object","properties":{"parameters":{"type":"array","items":{"$ref":"#/components/schemas/ParameterList"}}}}},"components/schemas/ParameterList":{"id":"components/schemas/ParameterList","kind":"json-schema","title":"ParameterList","data":{"type":"object","properties":{"parameter_id":{"type":"integer"},"sequence":{"type":"integer"},"parameter_value":{"type":"string"}}}},"components/schemas/ProgramDetailsResponse":{"id":"components/schemas/ProgramDetailsResponse","kind":"json-schema","title":"ProgramDetailsResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProgramDetail"}}}}},"components/schemas/ProgramDetail":{"id":"components/schemas/ProgramDetail","kind":"json-schema","title":"ProgramDetail","data":{"type":"object","properties":{"program_name":{"type":"string"},"program_id":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/ProgramParameter"}}}}},"components/schemas/ProgramParameter":{"id":"components/schemas/ProgramParameter","kind":"json-schema","title":"ProgramParameter","data":{"type":"object","properties":{"id":{"type":"integer"},"mandatory":{"type":"string"},"sequence":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"components/schemas/RevenueJobDetail":{"id":"components/schemas/RevenueJobDetail","kind":"json-schema","title":"RevenueJobDetail","data":{"type":"object","properties":{"data":{"type":"object","properties":{"actual_start_date":{"type":"string"},"crtd_by":{"type":"string"},"crtd_dt":{"type":"string"},"id":{"type":"integer"},"status":{"type":"string","enum":["Running","Error","Pending","Completed","Warning","Failed","Cancelled","Terminated","Incompatible"]},"updt_dt":{"type":"string"}}},"success":{"type":"boolean"}}}},"components/schemas/RevenueJobRequest":{"id":"components/schemas/RevenueJobRequest","kind":"json-schema","title":"RevenueJobRequest","data":{"type":"object","properties":{"rc_template_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the RC template that is defined in Zuora Revenue ("},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Policies > RC Grouping Template"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"org_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization ID that can be found in Zuora Revenue ("},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setups > Application > Organization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This field is required only for multi-organization tenants."},"children":[]}]}]}]}}}},"components/schemas/RevenueJobResponse":{"id":"components/schemas/RevenueJobResponse","kind":"json-schema","title":"RevenueJobResponse","data":{"type":"object","properties":{"message":{"type":"string"},"success":{"type":"boolean"}}}},"components/schemas/Journal":{"id":"components/schemas/Journal","kind":"json-schema","title":"Journal","data":{"type":"object","properties":{"client_id":{"type":"integer"},"crtd_by":{"type":"string"},"crtd_dt":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"status":{"type":"string"},"updt_by":{"type":"string"},"updt_dt":{"type":"string","format":"date-time"},"report_id":{"type":"integer","format":"int32"}}}},"components/schemas/stageError":{"id":"components/schemas/stageError","kind":"json-schema","title":"stageError","data":{"type":"object","properties":{"client_id":{"type":"integer"},"crtd_by":{"type":"string"},"crtd_dt":{"type":"string","format":"date-time"},"err_msg":{"type":"string"},"id":{"type":"integer"},"inv_line_id":{"type":"string"},"inv_line_num":{"type":"string"},"processed_flag":{"type":"string"},"sec_atr_val":{"type":"string"},"so_line_id":{"type":"string"},"so_line_num":{"type":"string"},"so_num":{"type":"string"},"type":{"type":"string"},"updt_by":{"type":"string"},"updt_dt":{"type":"string","format":"date-time"},"upload_id":{"type":"string"}}}},"components/schemas/uploadMapping":{"id":"components/schemas/uploadMapping","kind":"json-schema","title":"uploadMapping","data":{"type":"object","properties":{"client_id":{"type":"integer"},"col_name":{"type":"string"},"data_type":{"type":"string"},"id":{"type":"integer"},"label":{"type":"string"},"seq":{"type":"integer"},"upload_id":{"type":"integer"}}}},"components/schemas/uploadStatus":{"id":"components/schemas/uploadStatus","kind":"json-schema","title":"uploadStatus","data":{"type":"object","properties":{"file_log":{"type":"string"},"file_request_id":{"type":"integer"}}}},"components/schemas/Report":{"id":"components/schemas/Report","kind":"json-schema","title":"Report","data":{"type":"object","description":"A report definition in the tenant's report catalog. A report describes a data set (for example revenue waterfall or deferred revenue balances). It does not contain row data.","properties":{"id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique numeric identifier of the report definition. Use it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reportId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in every other Reports call."},"children":[]}]}]}],"example":10021,"format":"int32"},"name":{"type":"string","description":"Display name of the report. List reports returns the translated name when a translation exists for the caller's language; other operations return the stored name.","example":"Revenue Waterfall Report"},"description":{"type":"string","description":"Business description of what the report contains.","example":"Recognized and scheduled revenue by period for each revenue contract line","nullable":true},"category":{"type":"string","description":"Catalog grouping the report belongs to, as configured in Zuora Revenue.","example":"Revenue","nullable":true},"sequence":{"type":"integer","description":"Display order of the report inside its category. Lower numbers are shown first.","example":3,"format":"int32","nullable":true},"createdBy":{"type":"string","description":"User name that created the report definition.","example":"SYSADMIN","nullable":true},"createdAt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time the report definition was created, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2024-01-15T09:30:00","format":"date-time","nullable":true},"updatedBy":{"type":"string","description":"User name that last changed the report definition.","example":"FIN.ADMIN","nullable":true},"updatedAt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time the report definition was last changed, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-08-02T14:05:11","format":"date-time","nullable":true}}}},"components/schemas/LayoutField":{"id":"components/schemas/LayoutField","kind":"json-schema","title":"LayoutField","data":{"type":"object","description":"One output column of a report layout.","properties":{"id":{"type":"integer","description":"Unique identifier of this column assignment within the layout.","example":55012,"format":"int32"},"layoutId":{"type":"integer","description":"Identifier of the layout the column belongs to.","example":3105,"format":"int32"},"fieldId":{"type":"integer","description":"Identifier of the underlying report field (column definition).","example":8801,"format":"int32"},"seq":{"type":"integer","description":"Position of the column in the output file. Lower numbers appear further left.","example":1,"format":"int32","nullable":true},"sortSeq":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort priority of the column. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the layout does not sort by this column."},"children":[]}]}]}],"example":1,"format":"int32","nullable":true},"fieldName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical field name in lowerCamelCase. Use this value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you filter a report run."},"children":[]}]}]}],"example":"periodName","nullable":true},"fieldLabel":{"type":"string","description":"Column heading shown in the output file, translated to the caller's language when a translation exists.","example":"Period Name","nullable":true},"fieldType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Database data type of the column, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VARCHAR2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NUMBER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_TIME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"VARCHAR2","nullable":true}}}},"components/schemas/FilterOption":{"id":"components/schemas/FilterOption","kind":"json-schema","title":"FilterOption","data":{"type":"object","description":"One allowed value of a list-of-values (LOV) filter.","properties":{"label":{"type":"string","description":"Human-readable text of the option, already translated.","example":"Revenue"},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Value to send as the filter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you select this option."},"children":[]}]}]}],"example":"R"}}}},"components/schemas/LayoutFilter":{"id":"components/schemas/LayoutFilter","kind":"json-schema","title":"LayoutFilter","data":{"type":"object","description":"A filter that is defined on a report layout. Filters restrict the rows the report returns.","properties":{"id":{"type":"integer","description":"Unique identifier of the filter definition.","example":70033,"format":"int32"},"layoutId":{"type":"integer","description":"Identifier of the layout the filter belongs to.","example":3105,"format":"int32"},"fieldId":{"type":"integer","description":"Identifier of the report field the filter applies to.","example":8801,"format":"int32"},"fieldName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical field name in lowerCamelCase. Send this as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a run request to override the filter."},"children":[]}]}]}],"example":"periodName","nullable":true},"fieldLabel":{"type":"string","description":"Display label of the filter, translated when a translation exists.","example":"Period Name","nullable":true},"fieldType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Database data type of the filtered field, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VARCHAR2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NUMBER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATE_TIME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"VARCHAR2","nullable":true},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How the filter is presented and evaluated, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (pick from a list), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (from/to) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EQUALS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (single value)."},"children":[]}]}]}],"example":"LOV","nullable":true},"valueFrom":{"type":"string","description":"Saved default value, or the lower bound of a range filter.","example":"$revpro.CurrPrd","nullable":true},"valueTo":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saved upper bound of a range filter. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for single-value filters."},"children":[]}]}]}],"nullable":true},"createdBy":{"type":"string","description":"User name that created the filter.","example":"SYSADMIN","nullable":true},"createdAt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation date and time, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2024-01-15T09:30:00","format":"date-time","nullable":true},"updatedBy":{"type":"string","description":"User name that last changed the filter.","example":"SYSADMIN","nullable":true},"updatedAt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last change date and time, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2024-01-15T09:30:00","format":"date-time","nullable":true},"required":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the layout requires a value for this filter before a run is accepted; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the filter is optional."},"children":[]}]}]}],"example":true,"nullable":true},"options":{"type":"array","items":{"$ref":"#/components/schemas/FilterOption"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed values for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOV"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter. Always an array; empty for other filter types or when no list is configured."},"children":[]}]}]}]}}}},"components/schemas/ReportLayout":{"id":"components/schemas/ReportLayout","kind":"json-schema","title":"ReportLayout","data":{"type":"object","description":"A saved layout of a report: the columns to output, the filters with their defaults, and the output file-name prefix. A report can have many layouts.","properties":{"id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier of the layout. Send it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layoutId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you run the report."},"children":[]}]}]}],"example":3105,"format":"int32"},"reportId":{"type":"integer","description":"Identifier of the report the layout belongs to.","example":10021,"format":"int32"},"name":{"type":"string","description":"Layout name.","example":"Monthly Close - Summary"},"description":{"type":"string","description":"Layout description.","example":"Summary by period for month-end close","nullable":true},"filenamePrefix":{"type":"string","description":"Prefix used for the generated output file name.","example":"WF_SUMMARY","nullable":true},"createdBy":{"type":"string","description":"User name that created the layout.","example":"FIN.ADMIN","nullable":true},"createdAt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation date and time, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2025-03-01T10:00:00","format":"date-time","nullable":true},"updatedBy":{"type":"string","description":"User name that last changed the layout.","example":"FIN.ADMIN","nullable":true},"updatedAt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last change date and time, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-07-30T16:12:45","format":"date-time","nullable":true},"fields":{"type":"array","items":{"$ref":"#/components/schemas/LayoutField"},"description":"Output columns of the layout, in output order."},"filters":{"type":"array","items":{"$ref":"#/components/schemas/LayoutFilter"},"description":"Filters defined on the layout, with required flags and allowed values."}}}},"components/schemas/LayoutList":{"id":"components/schemas/LayoutList","kind":"json-schema","title":"LayoutList","data":{"type":"object","description":"Wrapper returned by the list-layouts operation.","properties":{"layouts":{"type":"array","items":{"$ref":"#/components/schemas/ReportLayout"},"description":"Layouts of the report, sorted by layout name. Each layout includes its fields and filters."},"totalCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of layouts in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"layouts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1,"format":"int32"}}}},"components/schemas/LayoutFieldList":{"id":"components/schemas/LayoutFieldList","kind":"json-schema","title":"LayoutFieldList","data":{"type":"object","description":"Wrapper returned by the list-layout-fields operation.","properties":{"layoutFields":{"type":"array","items":{"$ref":"#/components/schemas/LayoutField"},"description":"Output columns of the layout."}}}},"components/schemas/ReportMetadataColumn":{"id":"components/schemas/ReportMetadataColumn","kind":"json-schema","title":"ReportMetadataColumn","data":{"type":"object","description":"One field that the report can output.","properties":{"id":{"type":"integer","description":"Identifier of the report field.","example":8801,"format":"int32"},"fieldName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Technical field name as stored in the report definition (UPPER_SNAKE_CASE)."},"children":[]}]}]}],"example":"PERIOD_NAME"},"alias":{"type":"string","description":"Column alias used in the report output.","example":"PERIOD_NAME","nullable":true},"fieldType":{"type":"string","description":"Data type of the field.","example":"VARCHAR2","nullable":true},"label":{"type":"string","description":"Display label of the field.","example":"Period Name","nullable":true}}}},"components/schemas/ReportMetadataInfo":{"id":"components/schemas/ReportMetadataInfo","kind":"json-schema","title":"ReportMetadataInfo","data":{"type":"object","description":"Structural information about a report.","properties":{"description":{"type":"string","description":"Business description of the report.","example":"Recognized and scheduled revenue by period for each revenue contract line","nullable":true},"parameters":{"type":"array","items":{"type":"object"},"description":"Reserved for future use. Currently always an empty array."},"filters":{"type":"array","items":{"type":"object"},"description":"Reserved for future use. Currently always an empty array. Read filters from the layout operations instead."},"columns":{"type":"array","items":{"$ref":"#/components/schemas/ReportMetadataColumn"},"description":"All fields the report can output."}}}},"components/schemas/ReportMetadataLayout":{"id":"components/schemas/ReportMetadataLayout","kind":"json-schema","title":"ReportMetadataLayout","data":{"type":"object","description":"Short reference to a layout of the report.","properties":{"layoutId":{"type":"integer","description":"Identifier of the layout.","example":3105,"format":"int32"},"layoutName":{"type":"string","description":"Name of the layout.","example":"Monthly Close - Summary"},"isDefault":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when this is the report's default layout."},"children":[]}]}]}],"example":true}}}},"components/schemas/ReportMetadata":{"id":"components/schemas/ReportMetadata","kind":"json-schema","title":"ReportMetadata","data":{"type":"object","description":"Report metadata: identity, type, available columns and layouts.","properties":{"reportId":{"type":"integer","description":"Identifier of the report.","example":10021,"format":"int32"},"reportName":{"type":"string","description":"Name of the report.","example":"Revenue Waterfall Report"},"reportType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STANDARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a report delivered by Zuora; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a report your organization created."},"children":[]}]}]}],"example":"STANDARD","enum":["STANDARD","CUSTOM"]},"metadata":{"allOf":[{"$ref":"#/components/schemas/ReportMetadataInfo"}],"description":"Description, columns and reserved arrays."},"layouts":{"type":"array","items":{"$ref":"#/components/schemas/ReportMetadataLayout"},"description":"Layouts available for the report."}}}},"components/schemas/ReportFilterParam":{"id":"components/schemas/ReportFilterParam","kind":"json-schema","title":"ReportFilterParam","data":{"type":"object","description":"One filter condition applied to a report run.","properties":{"fieldName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to filter on, in lowerCamelCase as returned by the layout operations (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The service converts it to the stored field key."},"children":[]}]}]}],"example":"periodName"},"operator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison operator. When omitted, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used. See "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter operators"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the value rules of each operator."},"children":[]}]}]}],"example":"=","enum":["=","!=","<","<=",">",">=","LIKE","NOT LIKE","IS NULL","IS NOT NULL","BETWEEN","IN","VS"]},"value":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter value. Dates use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a comma-separated list. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the from-book. Omit for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IS NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IS NOT NULL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The macros "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$revpro.CurrPrd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$revpro.PriorPrd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are replaced with the current or prior open period name."},"children":[]}]}]}],"example":"$revpro.CurrPrd"},"valueTo":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upper bound for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BETWEEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (date "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or the to-book for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Not used by other operators."},"children":[]}]}]}]}},"required":["fieldName"]}},"components/schemas/RunReportRequest":{"id":"components/schemas/RunReportRequest","kind":"json-schema","title":"RunReportRequest","data":{"type":"object","description":"Request body that submits a report layout for execution.","properties":{"layoutId":{"type":"integer","description":"Identifier of the layout to run. Use a layout returned by List layouts for the same report.","example":3105,"format":"int32"},"filters":{"type":"array","items":{"$ref":"#/components/schemas/ReportFilterParam"},"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter conditions. Omit the property (or send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to apply all saved layout defaults. Send a partial list to override some filters; layout defaults fill in the rest. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to run with no filters at all (required filters are still enforced)."},"children":[]}]}]}]}},"required":["layoutId"]}},"components/schemas/ReportRun":{"id":"components/schemas/ReportRun","kind":"json-schema","title":"ReportRun","data":{"type":"object","description":"One execution (submission) of a report layout.","properties":{"id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission identifier of the run. Use it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"submissionId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to poll status and download."},"children":[]}]}]}],"example":482391,"format":"int64"},"reportId":{"type":"integer","description":"Identifier of the report that was run.","example":10021,"format":"int32"},"layoutId":{"type":"integer","description":"Identifier of the layout that was run.","example":3105,"format":"int32"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current run status. See "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report run status values"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Available","enum":["Submitted","Upload Started","File Created","Available","Error","Terminated","Cancelled"]},"fileName":{"type":"string","description":"Name of the output file. Populated once the file is produced.","example":"WF_SUMMARY_482391.csv","nullable":true},"filterParameters":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON text of the filters stored for the run, after defaults and period macros were resolved. Filters are stored with internal filter keys ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), operator ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"opr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", omitted for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and values ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"val1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"val2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Treat the content as informational; its format can change."},"children":[]}]}]}],"example":"{\"filters\":[{\"key\":\"A300\",\"val1\":\"SEP-2026\"},{\"key\":\"A101\",\"val1\":\"R\"}]}","nullable":true},"config":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON text of output options: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Show Filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Y/N, print the filters in the file) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Enable Totals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Y/N, add total rows)."},"children":[]}]}]}],"example":"{\"Show Filters\":\"Y\",\"Enable Totals\":\"N\"}","nullable":true},"createdBy":{"type":"string","description":"User that submitted the run.","example":"INTEGRATION.USER","nullable":true},"runDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time the run was submitted, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-10-09T07:15:02","format":"date-time","nullable":true},"updatedBy":{"type":"string","description":"User or process that last updated the run.","example":"INTEGRATION.USER","nullable":true},"updatedAt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time of the last status change, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-10-09T07:16:40","format":"date-time","nullable":true}}}},"components/schemas/ReportDownload":{"id":"components/schemas/ReportDownload","kind":"json-schema","title":"ReportDownload","data":{"type":"object","description":"Time-limited download link for a completed report file.","properties":{"presignedUrl":{"type":"string","description":"HTTPS URL of the report file. Download it with a plain HTTP GET and no Authorization header. Valid for 30 minutes.","example":"https://files.zuora.com/rev/1234567/reports/WF_SUMMARY_482391.csv?X-Amz-Expires=1800&X-Amz-Signature=3b1f...","format":"uri"},"expiresAt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTC date and time after which the URL stops working, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd'T'HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-10-09T07:47:10","format":"date-time"}}}},"components/schemas/MissingFiltersError":{"id":"components/schemas/MissingFiltersError","kind":"json-schema","title":"MissingFiltersError","data":{"type":"object","description":"Returned when a run is missing values for required layout filters.","properties":{"error":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fixed text "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Missing required filters"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Missing required filters"},"missingFilters":{"type":"array","items":{"type":"string"},"description":"Labels of the required filters that had no value after defaults were applied.","example":["Period Name"]}}}},"components/schemas/SimpleError":{"id":"components/schemas/SimpleError","kind":"json-schema","title":"SimpleError","data":{"type":"object","description":"Error returned by the report run and download operations.","properties":{"error":{"type":"string","description":"Human-readable description of the problem.","example":"Invalid report reference"},"errorCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable code, present for specific errors such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_PERIOD_ORG"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"INVALID_PERIOD_ORG"}}}},"components/schemas/RunStatusConflict":{"id":"components/schemas/RunStatusConflict","kind":"json-schema","title":"RunStatusConflict","data":{"type":"object","description":"Returned when a download is requested before the run is Available.","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current one-letter status code of the run: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Submitted, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"U"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Upload Started, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"C"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" File Created, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"E"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Error, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"T"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Terminated, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Cancelled."},"children":[]}]}]}],"example":"S","enum":["S","U","C","E","T","X",""]}}}},"components/schemas/ServiceError":{"id":"components/schemas/ServiceError","kind":"json-schema","title":"ServiceError","data":{"type":"object","description":"General error envelope used by the Revenue service for validation and unexpected errors.","properties":{"message":{"type":"string","description":"Description of the error.","example":"An error occurred: Invalid pagination parameters: page=-1, size=20"},"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error indicator. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for errors."},"children":[]}]}]}],"example":"1"}}}},"components/schemas/SpringError":{"id":"components/schemas/SpringError","kind":"json-schema","title":"SpringError","data":{"type":"object","description":"Standard error body returned when a request is rejected before it reaches the operation.","properties":{"timestamp":{"type":"string","description":"When the error occurred.","example":"2026-10-09T07:15:02.123+00:00","format":"date-time"},"status":{"type":"integer","description":"HTTP status code.","example":400},"error":{"type":"string","description":"HTTP reason phrase.","example":"Bad Request"}}}},"components/schemas/GatewayError":{"id":"components/schemas/GatewayError","kind":"json-schema","title":"GatewayError","data":{"type":"object","description":"Error returned by the Zuora One API gateway before the request reaches a Revenue service (authentication, authorization and rate limiting).","properties":{"message":{"type":"string","description":"Description of the gateway error.","example":"Authentication error"}}}},"components/schemas/ReportFile":{"id":"components/schemas/ReportFile","kind":"json-schema","title":"ReportFile","data":{"type":"object","description":"A completed (Available) report file produced by a report run.","properties":{"id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission identifier of the run that produced the file. Use it with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /reports/{report_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the v2 signed-URL operation."},"children":[]}]}]}],"example":482391},"file_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the generated file. Use it with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /reports/download/{filename}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"WF_SUMMARY_482391.csv"},"rep_name":{"type":"string","description":"Name of the report definition that produced the file.","example":"Revenue Waterfall Report"},"category":{"type":"string","description":"Report category.","example":"Revenue","nullable":true},"rep_desc":{"type":"string","description":"Report description.","example":"Recognized and scheduled revenue by period for each revenue contract line","nullable":true},"layout_name":{"type":"string","description":"Name of the layout that was run.","example":"Monthly Close - Summary"},"report_date":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date and time the run was created, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD-MM-YYYY HH24:MI:SS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"09-10-2026 07:15:02"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Run status. These operations only return Available runs, so the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Available"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on some tenant database platforms)."},"children":[]}]}]}],"example":"A","enum":["A","Available"]},"org_id":{"type":"string","description":"Organization security value of the run. Returned on some tenant database platforms only.","example":"101","nullable":true}}}},"components/schemas/ReportFileListResponse":{"id":"components/schemas/ReportFileListResponse","kind":"json-schema","title":"ReportFileListResponse","data":{"type":"object","description":"Success envelope for the report-file operations.","properties":{"Status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the call completed."},"children":[]}]}]}],"example":"Success"},"Message":{"type":"string","description":"Additional message. Empty on success.","example":""},"Result":{"type":"array","items":{"$ref":"#/components/schemas/ReportFile"},"description":"Matching Available report files. An empty array means nothing matched."}}}},"components/schemas/RiaError":{"id":"components/schemas/RiaError","kind":"json-schema","title":"RiaError","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error envelope used by the Integration service. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or, on a few operations, the error text itself), and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the detail."},"children":[]}]}]}],"properties":{"Status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for most failures. Some BI View operations put the error text (or, for the v1 column list, the columns) here."},"children":[]}]}]}],"example":"Error"},"Message":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable error detail. A string on most errors; an object such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"Invalid_fields\": [...]}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on field validation errors."},"children":[]}]}]}],"example":"Invalid date format 2026-09-22 for createddate"},"Result":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional error detail or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Some BI View operations return the message text or the list of supported views here."},"children":[]}]}]}]}}}},"components/schemas/SignedUrlResponse":{"id":"components/schemas/SignedUrlResponse","kind":"json-schema","title":"SignedUrlResponse","data":{"type":"object","description":"Signed download URL for a completed report.","properties":{"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the URL was generated."},"children":[]}]}]}],"example":true},"signed_url":{"type":"string","description":"HTTPS URL of the report file. Download it with a plain HTTP GET; it is valid for 30 minutes (1,800 seconds).","example":"https://files.zuora.com/rev/1234567/reports/WF_SUMMARY_482391.csv?X-Amz-Expires=1800&X-Amz-Signature=9ac2...","format":"uri"}}}},"components/schemas/SignedUrlError":{"id":"components/schemas/SignedUrlError","kind":"json-schema","title":"SignedUrlError","data":{"type":"object","description":"Returned when no signed URL can be generated.","properties":{"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":false},"error":{"type":"string","description":"Reason the URL could not be generated.","example":"Report not found for Submission Id: 482391"}}}},"components/schemas/BiViewColumn":{"id":"components/schemas/BiViewColumn","kind":"json-schema","title":"BiViewColumn","data":{"type":"object","description":"One column of a BI View.","properties":{"column_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Column name. Use it in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list to select columns."},"children":[]}]}]}],"example":"RC_ID"},"data_type":{"type":"string","description":"Database data type of the column.","example":"NUMBER"},"data_length":{"type":"integer","description":"Maximum length of the column in bytes.","example":22},"data_precision":{"type":"integer","description":"Numeric precision, when applicable.","example":38,"nullable":true},"data_scale":{"type":"integer","description":"Numeric scale, when applicable.","example":0,"nullable":true}}}},"components/schemas/BiViewFieldsRequest":{"id":"components/schemas/BiViewFieldsRequest","kind":"json-schema","title":"BiViewFieldsRequest","data":{"type":"object","description":"Optional body that selects which BI View columns to return. You can also send a plain JSON array of column names.","properties":{"Fields":{"type":"array","items":{"type":"string"},"description":"Column names to return. Names are matched case-insensitively against the describe-columns output.","example":["RC_ID","RC_NUM","UPDT_DT"]}}}},"components/schemas/BiViewCount":{"id":"components/schemas/BiViewCount","kind":"json-schema","title":"BiViewCount","data":{"type":"object","description":"Row count of a BI View for a date range.","properties":{"count":{"type":"integer","description":"Number of rows in the view for the requested date range, limited to the organizations the caller can access.","example":25430}}}},"components/schemas/BiViewCountV1":{"id":"components/schemas/BiViewCountV1","kind":"json-schema","title":"BiViewCountV1","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Row count envelope returned by the v1 BI Views operation when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"Status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the count was computed."},"children":[]}]}]}],"example":"Success"},"Result":{"allOf":[{"$ref":"#/components/schemas/BiViewCount"}],"description":"The count."}}}},"components/schemas/BiViewReportSubmitResponse":{"id":"components/schemas/BiViewReportSubmitResponse","kind":"json-schema","title":"BiViewReportSubmitResponse","data":{"type":"object","description":"Result of submitting a BI View as a background report.","properties":{"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the report job was accepted."},"children":[]}]}]}],"example":true},"report_id":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submission identifier of the report job. Use it with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/integration/v1/reports/{report_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /api/integration/v2/reports/signedurl/{report_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":482455},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reason the job was not accepted (present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"Unable to submit"}}}},"components/schemas/BiViewTaskFilterParams":{"id":"components/schemas/BiViewTaskFilterParams","kind":"json-schema","title":"BiViewTaskFilterParams","data":{"type":"object","description":"Date filters of the BI View query.","properties":{"fromDate":{"type":"string","description":"Start of the query date range.","example":"2026-09-01 00:00:00"},"toDate":{"type":"string","description":"End of the query date range.","example":"2026-09-30 23:59:59"}}}},"components/schemas/BiViewTaskQueryConfig":{"id":"components/schemas/BiViewTaskQueryConfig","kind":"json-schema","title":"BiViewTaskQueryConfig","data":{"type":"object","description":"What the task is querying.","properties":{"object_name":{"type":"string","description":"BI View database object being read.","example":"RPRO_BI3_RC_LNS_V"},"filter_params":{"allOf":[{"$ref":"#/components/schemas/BiViewTaskFilterParams"}],"description":"Date range of the query."}}}},"components/schemas/BiViewTaskTime":{"id":"components/schemas/BiViewTaskTime","kind":"json-schema","title":"BiViewTaskTime","data":{"type":"object","description":"Timing information of a BI View task.","properties":{"initated_time":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the task started, ISO 8601 date and time. (The property name is spelled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initated_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]}],"example":"2026-10-09T07:20:01.512000"},"last_activity":{"type":"string","description":"When the task last reported progress, ISO 8601 date and time.","example":"2026-10-09T07:21:44.008000"},"elapsed_time":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time since the task last reported progress, formatted "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"H:MM:SS.ffffff"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A large value means the task may be stuck."},"children":[]}]}]}],"example":"0:00:12.405000","nullable":true}}}},"components/schemas/BiViewTask":{"id":"components/schemas/BiViewTask","kind":"json-schema","title":"BiViewTask","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"State of a background BI View extraction task. The task identifier is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuation-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned on page 1."},"children":[]}]}]}],"properties":{"task_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task identifier (same value as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"continuation-token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Task status. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADDED-TO-QUEUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"META-DATA-SCANNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCANNING-PAGE-n"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMMITING-PAGE-n"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MAX-REQUESTED-PAGE-REACHED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO-RECORD-FOUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"END-OF-QUERY-DATA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are in-progress states; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are final."},"children":[]}]}]}],"example":"COMMITING-PAGE-3"},"message":{"type":"string","description":"Latest progress or error message.","nullable":true},"metric":{"type":"integer","description":"Rows written by the latest step.","example":1000,"nullable":true},"accumulate":{"type":"integer","description":"Total rows written so far.","example":3000,"nullable":true},"query_config":{"allOf":[{"$ref":"#/components/schemas/BiViewTaskQueryConfig"}],"description":"View and date range being queried."},"activity_tracker":{"allOf":[{"$ref":"#/components/schemas/BiViewTaskTime"}],"description":"Timing information."}}}},"components/schemas/BiViewTaskQueues":{"id":"components/schemas/BiViewTaskQueues","kind":"json-schema","title":"BiViewTaskQueues","data":{"type":"object","description":"BI View tasks of the tenant grouped by state.","properties":{"active":{"type":"array","items":{"$ref":"#/components/schemas/BiViewTask"},"description":"Tasks that are running and reported progress recently."},"completed":{"type":"array","items":{"$ref":"#/components/schemas/BiViewTask"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tasks that finished ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"stale":{"type":"array","items":{"$ref":"#/components/schemas/BiViewTask"},"description":"Running tasks with no progress within the staleness threshold (240 seconds by default)."},"draining":{"type":"array","items":{"type":"string"},"description":"Identifiers of tasks whose details have expired and are being removed."}}}},"components/schemas/JournalEntryListPage":{"id":"components/schemas/JournalEntryListPage","kind":"json-schema","title":"JournalEntryListPage","data":{"type":"object","description":"A page of journal entries.","properties":{"pageNumber":{"type":"integer","format":"int32","description":"1-based number of the page returned.","example":1,"nullable":true},"pageSize":{"type":"integer","format":"int32","description":"Maximum number of records per page (capped at 40).","example":20,"nullable":true},"totalRecords":{"type":"integer","format":"int64","description":"Total number of records that match the query across all pages.","example":1,"nullable":true},"result":{"type":"array","items":{"$ref":"#/components/schemas/JournalEntryListItem"},"description":"Records on this page.","nullable":true}}}},"components/schemas/JournalEntryListItem":{"id":"components/schemas/JournalEntryListItem","kind":"json-schema","title":"JournalEntryListItem","data":{"type":"object","description":"Summary row for a journal entry in list and search results.","properties":{"id":{"type":"integer","format":"int64","description":"Unique system-generated identifier of the journal entry (JE header ID).","example":10045,"nullable":true},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the journal entry. Shown in the Zuora Revenue UI and in GL interfaces. Must be meaningful to approvers, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEP-2026 Revenue Reclass"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"SEP-2026 Revenue Reclass","nullable":true},"description":{"type":"string","description":"Free-text description of the journal entry's business purpose.","example":"Reclass deferred revenue for contract RC-1001","nullable":true},"reversalStatus":{"type":"string","description":"Approval status of the reversal of this entry, when a reversal was requested. Empty when the entry has not been reversed.","example":"","nullable":true},"categoryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journal entry category code. Classifies why the entry is posted (for example an accrual, reclass or adjustment). Valid values are configured in your tenant's MANUAL_JOURNAL lookup; retrieve them from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"categoryId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"RECLASS","nullable":true},"exRateType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange rate type used to convert transaction currency to functional and reporting currency (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Corporate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata. (Filter and sort on this property using the name "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]}],"example":"User","nullable":true},"periodId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the posting period, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEP-2026"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (in list results this property holds the period name, not the numeric ID; filters compare against the name)."},"children":[]}]}]}],"example":"SEP-2026","nullable":true},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journal entry status. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"New"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Validated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Rule not Defined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"New","nullable":true},"reversalPeriodId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the reversal period, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OCT-2026"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (period name, not the numeric ID)."},"children":[]}]}]}],"example":"OCT-2026","nullable":true},"hashTotal":{"type":"number","format":"double","description":"Hash total of the entry: the sum of all line amounts. Useful as a control total when reconciling uploads.","example":3000,"nullable":true},"sobName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the Set of Books. On create and update the service derives this from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; any value you send is overwritten."},"children":[]}]}]}],"example":"US Primary SOB","nullable":true},"sobId":{"type":"integer","format":"int64","description":"Identifier of the Set of Books (SOB) the entry posts to. A Set of Books groups the ledger, functional currency and calendar used for accounting.","example":1,"nullable":true},"functionalCurrency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217 currency code of the functional (ledger) currency of the Set of Books, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"USD","nullable":true},"createdBy":{"type":"string","description":"User who created the record.","example":"jane.doe@example.com","nullable":true},"createdDate":{"type":"string","description":"Timestamp when the record was created (ISO 8601).","example":"2026-09-28 10:21:04","nullable":true},"updatedBy":{"type":"string","description":"User who last updated the record.","example":"jane.doe@example.com","nullable":true},"updatedDate":{"type":"string","description":"Timestamp when the record was last updated (ISO 8601).","example":"2026-09-28 10:21:04","nullable":true},"approverName":{"type":"string","description":"Name of the approver currently assigned to the entry by the approval rule. Read-only on most flows.","nullable":true},"bookId":{"type":"integer","format":"int32","description":"Identifier of the accounting book (for example the primary book or a secondary/parallel book) the entry belongs to.","example":1,"nullable":true},"secAtrVal":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization (security attribute value) of the entry. Same meaning as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"101","nullable":true}}}},"components/schemas/JournalEntryUpdateResponse":{"id":"components/schemas/JournalEntryUpdateResponse","kind":"json-schema","title":"JournalEntryUpdateResponse","data":{"type":"object","description":"Result of an update.","properties":{"id":{"type":"integer","format":"int64","description":"Unique system-generated identifier of the journal entry (JE header ID).","example":10045,"nullable":true},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journal entry status. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"New"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Validated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Rule not Defined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"New","nullable":true},"waterfallStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of revenue waterfall (schedule) generation for the entry. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For approved entries this reflects the final waterfall; otherwise the preview waterfall."},"children":[]}]}]}],"example":"NEW","nullable":true}}}},"components/schemas/CreateJournalEntryRequest":{"id":"components/schemas/CreateJournalEntryRequest","kind":"json-schema","title":"CreateJournalEntryRequest","data":{"type":"object","description":"JSON body for creating a journal entry with its lines in one call.","required":["jeHeader","lines"],"properties":{"jeHeader":{"allOf":[{"$ref":"#/components/schemas/JournalEntryHeaderInput"}],"description":"Journal entry header."},"lines":{"type":"array","items":{"$ref":"#/components/schemas/JournalEntryLineInput"},"description":"Journal entry lines. At least one line is required."}}}},"components/schemas/JournalEntryLineDataset":{"id":"components/schemas/JournalEntryLineDataset","kind":"json-schema","title":"JournalEntryLineDataset","data":{"type":"object","description":"A journal entry line returned by the copy-lines operation.","properties":{"id":{"type":"integer","format":"int64","description":"Unique system-generated identifier of the journal entry line.","example":70001,"nullable":true},"headerId":{"type":"integer","format":"int64","description":"Identifier of the journal entry (header) this record belongs to.","example":10045,"nullable":true},"clientId":{"type":"integer","format":"int32","description":"Identifier of your Zuora Revenue client (tenant partition). Informational.","example":1,"nullable":true},"orgId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization (operating unit) identifier the entry belongs to, also called the security attribute value ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secAtrVal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"101","nullable":true},"createdBy":{"type":"string","description":"User who created the record.","example":"jane.doe@example.com","nullable":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp when the record was created (ISO 8601).","example":"2026-09-28T10:21:04.000+00:00","nullable":true},"updatedBy":{"type":"string","description":"User who last updated the record.","example":"jane.doe@example.com","nullable":true},"updatedDate":{"type":"string","format":"date-time","description":"Timestamp when the record was last updated (ISO 8601).","example":"2026-09-28T10:21:04.000+00:00","nullable":true},"bookId":{"type":"integer","format":"int32","description":"Identifier of the accounting book (for example the primary book or a secondary/parallel book) the entry belongs to.","example":1,"nullable":true},"rcId":{"type":"integer","format":"int64","description":"Revenue contract (RC) identifier the line relates to.","example":1001,"nullable":true},"rcLineId":{"type":"integer","format":"int64","description":"Revenue contract line identifier the line relates to.","example":50001,"nullable":true},"currency":{"type":"string","description":"ISO 4217 transaction currency of the line amount.","example":"USD","nullable":true},"debit":{"type":"number","format":"double","description":"Debit amount in transaction currency.","example":1500,"nullable":true},"credit":{"type":"number","format":"double","description":"Credit amount in transaction currency.","nullable":true},"exchangeRateDate":{"type":"string","format":"date-time","description":"Date the exchange rates apply to.","example":"2026-09-30T00:00:00.000+00:00","nullable":true},"exchangeRate":{"type":"number","format":"double","description":"Functional exchange rate: converts transaction currency to functional currency.","example":1,"nullable":true},"gexchangeRate":{"type":"number","format":"double","description":"Global (reporting) exchange rate: converts functional currency to the reporting currency.","example":1,"nullable":true},"startDate":{"type":"string","format":"date-time","description":"Start date of the revenue recognition period for the line.","example":"2026-09-01T00:00:00.000+00:00","nullable":true},"endDate":{"type":"string","format":"date-time","description":"End date of the revenue recognition period for the line.","example":"2026-09-30T00:00:00.000+00:00","nullable":true},"reason":{"type":"string","description":"Reason code explaining the adjustment.","example":"RECLASS","nullable":true},"errorMessage":{"type":"string","description":"Validation error recorded on the line by the service, if any.","nullable":true},"description":{"type":"string","description":"Free-text description of the line.","example":"Move deferred revenue to revenue","nullable":true},"comments":{"type":"string","description":"Free-text comments on the line.","nullable":true},"accountType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue activity (account) type of the line, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Revenue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Contract Liability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Adjustment Revenue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"Contract Liability","nullable":true},"soLineId":{"type":"string","description":"Sales order (document) line identifier the line relates to.","example":"SO-50012-1","nullable":true},"soNum":{"type":"string","description":"Sales order (document) number the line relates to.","example":"SO-50012","nullable":true},"costOrVcType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"typeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a cost type or a variable consideration type."},"children":[]}]}]}],"nullable":true},"jeSetNo":{"type":"integer","format":"int64","description":"Set number that groups lines into a balanced set. Debits and credits within the same set number must net to zero. Use 1, 2, 3 ... to post several independent balanced sets in one entry.","example":1,"nullable":true},"unbillAccounting":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled accounting flag ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" posts the line to unbilled (contract asset/unbilled receivable) accounts."},"children":[]}]}]}],"example":"N","nullable":true},"accountCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"General ledger account code (accounting segments joined by your configured delimiter), for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000-200-4000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1000-200-4000","nullable":true},"typeName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the cost type or variable consideration (VC) type when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a cost or VC account."},"children":[]}]}]}],"nullable":true},"reference1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference3":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference4":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference5":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference6":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference7":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference8":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference8"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference9":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference10":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference11":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference11"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference12":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference12"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference13":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference13"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference14":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference15":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"creditAccountType":{"type":"string","description":"Account type used for the credit side when a single line carries both sides.","nullable":true},"debitAccountType":{"type":"string","description":"Account type used for the debit side when a single line carries both sides.","nullable":true},"createPeriodId":{"type":"string","description":"Identifier of the period in which the record was created.","example":"202609","nullable":true}}}},"components/schemas/CopyJournalEntryRequest":{"id":"components/schemas/CopyJournalEntryRequest","kind":"json-schema","title":"CopyJournalEntryRequest","data":{"type":"object","description":"Optional overrides for the copied journal entry.","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name for the copy. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Copy of <original name>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"OCT-2026 Revenue Reclass","nullable":true},"periodId":{"type":"integer","format":"int32","description":"Posting period for the copy. Defaults to the current open period.","example":202610,"nullable":true}}}},"components/schemas/JournalEntryResponse":{"id":"components/schemas/JournalEntryResponse","kind":"json-schema","title":"JournalEntryResponse","data":{"type":"object","description":"A journal entry with its header and, depending on the operation, a page of lines or schedules.","properties":{"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the operation succeeded."},"children":[]}]}]}],"example":true},"id":{"type":"integer","format":"int64","description":"Unique system-generated identifier of the journal entry (JE header ID).","example":10045,"nullable":true},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the journal entry. Shown in the Zuora Revenue UI and in GL interfaces. Must be meaningful to approvers, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEP-2026 Revenue Reclass"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"SEP-2026 Revenue Reclass","nullable":true},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journal entry status. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"New"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Validated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Rule not Defined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"New","nullable":true},"description":{"type":"string","description":"Free-text description of the journal entry's business purpose.","example":"Reclass deferred revenue for contract RC-1001","nullable":true},"waterfallStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of revenue waterfall (schedule) generation for the entry. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For approved entries this reflects the final waterfall; otherwise the preview waterfall."},"children":[]}]}]}],"example":"NEW","nullable":true},"jeHeader":{"allOf":[{"$ref":"#/components/schemas/JournalEntryHeader"}],"description":"Full header. Returned by create, get and copy."},"lines":{"allOf":[{"$ref":"#/components/schemas/JournalEntryLinesPage"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page of lines. Returned by GET /journal-entries/{jeId}/lines."},"children":[]}]}]}]},"schedules":{"allOf":[{"$ref":"#/components/schemas/JournalEntrySchedulesPage"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page of schedules. Returned by GET /journal-entries/{jeId}/schedules."},"children":[]}]}]}]}}}},"components/schemas/UpdateJournalEntryRequest":{"id":"components/schemas/UpdateJournalEntryRequest","kind":"json-schema","title":"UpdateJournalEntryRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update of a journal entry header. Send only the fields you want to change; omitted fields are left unchanged. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"revRecType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approvalCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be changed after create."},"children":[]}]}]}],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the journal entry. Shown in the Zuora Revenue UI and in GL interfaces. Must be meaningful to approvers, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEP-2026 Revenue Reclass"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"SEP-2026 Revenue Reclass v2","nullable":true},"description":{"type":"string","description":"Free-text description of the journal entry's business purpose.","example":"Updated description","nullable":true},"periodId":{"type":"integer","format":"int64","description":"Identifier of the accounting (posting) period the journal entry is posted to. The period must be open. Retrieve valid IDs from GET /journal-entries/metadata/periods or GET /journal-entries/current-period.","example":202609,"nullable":true},"reversalPeriodId":{"type":"integer","format":"int64","description":"Identifier of the accounting period in which an automatic reversal of this entry is posted. Leave empty when the entry should not reverse.","example":202610,"nullable":true},"categoryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journal entry category code. Classifies why the entry is posted (for example an accrual, reclass or adjustment). Valid values are configured in your tenant's MANUAL_JOURNAL lookup; retrieve them from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"categoryId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"RECLASS","nullable":true},"exchangeRateType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange rate type used to convert transaction currency to functional and reporting currency (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Corporate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"User","nullable":true},"sobName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the Set of Books. On create and update the service derives this from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; any value you send is overwritten."},"children":[]}]}]}],"nullable":true},"sobId":{"type":"integer","format":"int64","description":"Identifier of the Set of Books (SOB) the entry posts to. A Set of Books groups the ledger, functional currency and calendar used for accounting. When supplied it must match an existing Set of Books.","example":1,"nullable":true},"functionalCurrency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217 currency code of the functional (ledger) currency of the Set of Books, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"USD","nullable":true},"accountMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting method used to post the entry. Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountingMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"Standard","nullable":true},"bookId":{"type":"integer","format":"int64","description":"Identifier of the accounting book (for example the primary book or a secondary/parallel book) the entry belongs to.","example":1,"nullable":true},"orgId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization (operating unit) identifier the entry belongs to, also called the security attribute value ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secAtrVal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"101","nullable":true},"glTransfer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the entry is transferred to the general ledger. Accepted values on input: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the service reports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when not set)."},"children":[]}]}]}],"enum":["Yes","No"],"example":"Yes","nullable":true},"approverName":{"type":"string","description":"Name of the approver currently assigned to the entry by the approval rule. Read-only on most flows.","nullable":true}}}},"components/schemas/JournalEntryLine":{"id":"components/schemas/JournalEntryLine","kind":"json-schema","title":"JournalEntryLine","data":{"type":"object","description":"A journal entry line as returned by the service.","properties":{"id":{"type":"integer","format":"int64","description":"Unique system-generated identifier of the journal entry line.","example":70001,"nullable":true},"headerId":{"type":"integer","format":"int64","description":"Identifier of the journal entry (header) this record belongs to.","example":10045,"nullable":true},"clientId":{"type":"integer","format":"int32","description":"Identifier of your Zuora Revenue client (tenant partition). Informational.","example":1,"nullable":true},"orgId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization (operating unit) identifier the entry belongs to, also called the security attribute value ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secAtrVal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"101","nullable":true},"createdBy":{"type":"string","description":"User who created the record.","example":"jane.doe@example.com","nullable":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp when the record was created (ISO 8601).","example":"2026-09-28T10:21:04.000+00:00","nullable":true},"updatedBy":{"type":"string","description":"User who last updated the record.","example":"jane.doe@example.com","nullable":true},"updatedDate":{"type":"string","format":"date-time","description":"Timestamp when the record was last updated (ISO 8601).","example":"2026-09-28T10:21:04.000+00:00","nullable":true},"bookId":{"type":"integer","format":"int32","description":"Identifier of the accounting book (for example the primary book or a secondary/parallel book) the entry belongs to.","example":1,"nullable":true},"rcId":{"type":"integer","format":"int64","description":"Revenue contract (RC) identifier the line relates to.","example":1001,"nullable":true},"rcLineId":{"type":"integer","format":"int64","description":"Revenue contract line identifier the line relates to.","example":50001,"nullable":true},"currency":{"type":"string","description":"ISO 4217 transaction currency of the line amount.","example":"USD","nullable":true},"debit":{"type":"number","format":"double","description":"Debit amount in transaction currency.","example":1500,"nullable":true},"credit":{"type":"number","format":"double","description":"Credit amount in transaction currency.","nullable":true},"exchangeRateDate":{"type":"string","format":"date-time","description":"Date the exchange rates apply to.","example":"2026-09-30T00:00:00.000+00:00","nullable":true},"exchangeRate":{"type":"number","format":"double","description":"Functional exchange rate: converts transaction currency to functional currency.","example":1,"nullable":true},"gexchangeRate":{"type":"number","format":"double","description":"Global (reporting) exchange rate: converts functional currency to the reporting currency.","example":1,"nullable":true},"startDate":{"type":"string","format":"date-time","description":"Start date of the revenue recognition period for the line.","example":"2026-09-01T00:00:00.000+00:00","nullable":true},"endDate":{"type":"string","format":"date-time","description":"End date of the revenue recognition period for the line.","example":"2026-09-30T00:00:00.000+00:00","nullable":true},"reason":{"type":"string","description":"Reason code explaining the adjustment.","example":"RECLASS","nullable":true},"errorMessage":{"type":"string","description":"Validation error recorded on the line by the service, if any.","nullable":true},"description":{"type":"string","description":"Free-text description of the line.","example":"Move deferred revenue to revenue","nullable":true},"comments":{"type":"string","description":"Free-text comments on the line.","nullable":true},"accountType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue activity (account) type of the line, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Revenue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Contract Liability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Adjustment Revenue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"Contract Liability","nullable":true},"soLineId":{"type":"string","description":"Sales order (document) line identifier the line relates to.","example":"SO-50012-1","nullable":true},"soNum":{"type":"string","description":"Sales order (document) number the line relates to.","example":"SO-50012","nullable":true},"costOrVcType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"typeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a cost type or a variable consideration type."},"children":[]}]}]}],"nullable":true},"jeSetNo":{"type":"integer","format":"int64","description":"Set number that groups lines into a balanced set. Debits and credits within the same set number must net to zero. Use 1, 2, 3 ... to post several independent balanced sets in one entry.","example":1,"nullable":true},"unbillAccounting":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled accounting flag ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" posts the line to unbilled (contract asset/unbilled receivable) accounts."},"children":[]}]}]}],"example":"N","nullable":true},"accountCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"General ledger account code (accounting segments joined by your configured delimiter), for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000-200-4000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1000-200-4000","nullable":true},"typeName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the cost type or variable consideration (VC) type when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a cost or VC account."},"children":[]}]}]}],"nullable":true},"reference1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference3":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference4":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference5":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference6":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference7":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference8":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference8"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference9":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference10":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference11":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference11"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference12":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference12"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference13":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference13"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference14":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference15":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true}}}},"components/schemas/JournalEntrySchedulesPage":{"id":"components/schemas/JournalEntrySchedulesPage","kind":"json-schema","title":"JournalEntrySchedulesPage","data":{"type":"object","description":"A page of revenue schedules generated by a journal entry.","properties":{"pageNumber":{"type":"integer","format":"int32","description":"1-based number of the page returned.","example":1,"nullable":true},"pageSize":{"type":"integer","format":"int32","description":"Maximum number of records per page (capped at 40).","example":20,"nullable":true},"totalRecords":{"type":"integer","format":"int64","description":"Total number of records that match the query across all pages.","example":1,"nullable":true},"result":{"type":"array","items":{"$ref":"#/components/schemas/JournalEntrySchedule"},"description":"Records on this page.","nullable":true}}}},"components/schemas/JournalEntryLinesPage":{"id":"components/schemas/JournalEntryLinesPage","kind":"json-schema","title":"JournalEntryLinesPage","data":{"type":"object","description":"A page of journal entry lines.","properties":{"pageNumber":{"type":"integer","format":"int32","description":"1-based number of the page returned.","example":1,"nullable":true},"pageSize":{"type":"integer","format":"int32","description":"Maximum number of records per page (capped at 40).","example":20,"nullable":true},"totalRecords":{"type":"integer","format":"int64","description":"Total number of records that match the query across all pages.","example":1,"nullable":true},"result":{"type":"array","items":{"$ref":"#/components/schemas/JournalEntryLine"},"description":"Records on this page.","nullable":true}}}},"components/schemas/CopyJournalEntryLinesRequest":{"id":"components/schemas/CopyJournalEntryLinesRequest","kind":"json-schema","title":"CopyJournalEntryLinesRequest","data":{"type":"object","description":"Lines to copy and the destination entry.","required":["lineIds"],"properties":{"targetJeId":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journal entry that receives the copied lines. Defaults to the source entry ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the path)."},"children":[]}]}]}],"example":10046,"nullable":true},"lineIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"IDs of the lines to copy.","example":[70001,70002]}}}},"components/schemas/UpdateJournalEntryMultipartRequest":{"id":"components/schemas/UpdateJournalEntryMultipartRequest","kind":"json-schema","title":"UpdateJournalEntryMultipartRequest","data":{"type":"object","description":"Multipart form for a full-file update of a journal entry's lines from CSV.","required":["lines"],"properties":{"lines":{"type":"string","format":"binary","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV file containing the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complete"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set of lines for the entry (at least one). Rows whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" column matches an existing line are updated, other rows are inserted, and existing lines that are absent from the file are deleted. May include an optional header section."},"children":[]}]}]}]},"jeHeader":{"allOf":[{"$ref":"#/components/schemas/UpdateJournalEntryRequest"}],"description":"Optional header changes as a JSON part. Must be omitted when the CSV contains a header section."}}}},"components/schemas/CreateJournalEntryMultipartRequest":{"id":"components/schemas/CreateJournalEntryMultipartRequest","kind":"json-schema","title":"CreateJournalEntryMultipartRequest","data":{"type":"object","description":"Multipart form for creating a journal entry from a CSV file.","required":["lines"],"properties":{"lines":{"type":"string","format":"binary","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CSV file (UTF-8). Either a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"combined"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file (header titles row, one header values row, a blank line, then line titles and line rows) or a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lines-only"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file. Download the template from GET /journal-entries/template."},"children":[]}]}]}]},"jeHeader":{"allOf":[{"$ref":"#/components/schemas/JournalEntryHeaderInput"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header as a JSON part ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type: application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Required with a lines-only CSV; must be omitted when the CSV contains a header section."},"children":[]}]}]}]}}}},"components/schemas/JournalEntryHeader":{"id":"components/schemas/JournalEntryHeader","kind":"json-schema","title":"JournalEntryHeader","data":{"type":"object","description":"Full journal entry header as stored by Zuora Revenue.","properties":{"id":{"type":"integer","format":"int64","description":"Unique system-generated identifier of the journal entry (JE header ID).","example":10045,"nullable":true},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the journal entry. Shown in the Zuora Revenue UI and in GL interfaces. Must be meaningful to approvers, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEP-2026 Revenue Reclass"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"SEP-2026 Revenue Reclass","nullable":true},"description":{"type":"string","description":"Free-text description of the journal entry's business purpose.","example":"Reclass deferred revenue for contract RC-1001","nullable":true},"categoryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journal entry category code. Classifies why the entry is posted (for example an accrual, reclass or adjustment). Valid values are configured in your tenant's MANUAL_JOURNAL lookup; retrieve them from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"categoryId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"RECLASS","nullable":true},"exchangeRateType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange rate type used to convert transaction currency to functional and reporting currency (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Corporate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"User","nullable":true},"sobId":{"type":"integer","format":"int64","description":"Identifier of the Set of Books (SOB) the entry posts to. A Set of Books groups the ledger, functional currency and calendar used for accounting.","example":1,"nullable":true},"sobName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the Set of Books. On create and update the service derives this from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; any value you send is overwritten."},"children":[]}]}]}],"example":"US Primary SOB","nullable":true},"functionalCurrency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217 currency code of the functional (ledger) currency of the Set of Books, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"USD","nullable":true},"periodId":{"type":"integer","format":"int32","description":"Identifier of the accounting (posting) period the journal entry is posted to. The period must be open. Retrieve valid IDs from GET /journal-entries/metadata/periods or GET /journal-entries/current-period.","example":202609,"nullable":true},"reversalPeriodId":{"type":"integer","format":"int32","description":"Identifier of the accounting period in which an automatic reversal of this entry is posted. Leave empty when the entry should not reverse.","example":202610,"nullable":true},"reversalStatus":{"type":"string","description":"Approval status of the reversal of this entry, when a reversal was requested. Empty when the entry has not been reversed.","example":"","nullable":true},"clientId":{"type":"integer","format":"int32","description":"Identifier of your Zuora Revenue client (tenant partition). Informational.","example":1,"nullable":true},"orgId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization (operating unit) identifier the entry belongs to, also called the security attribute value ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secAtrVal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"101","nullable":true},"createdBy":{"type":"string","description":"User who created the record.","example":"jane.doe@example.com","nullable":true},"createdDate":{"type":"string","format":"date-time","description":"Timestamp when the record was created (ISO 8601).","example":"2026-09-28T10:21:04.000+00:00","nullable":true},"updatedBy":{"type":"string","description":"User who last updated the record.","example":"jane.doe@example.com","nullable":true},"updatedDate":{"type":"string","format":"date-time","description":"Timestamp when the record was last updated (ISO 8601).","example":"2026-09-28T10:21:04.000+00:00","nullable":true},"bookId":{"type":"integer","format":"int32","description":"Identifier of the accounting book (for example the primary book or a secondary/parallel book) the entry belongs to.","example":1,"nullable":true},"approverName":{"type":"string","description":"Name of the approver currently assigned to the entry by the approval rule. Read-only on most flows.","nullable":true},"approvalRuleName":{"type":"string","description":"Name of the approval rule that matched this entry.","nullable":true},"revRecType":{"type":"string","description":"Revenue recognition type that drives the accounting method applied to the entry. Set on create only.","example":"STANDARD","nullable":true},"accountMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting method used to post the entry. Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountingMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"Standard","nullable":true},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journal entry status. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"New"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Draft"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Validated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Cancelled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Rule not Defined"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"New","nullable":true},"approvalCurrency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217 currency used to evaluate approval rules (thresholds) for this entry. Optional; valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approvalCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"USD","nullable":true},"periodDisplayValue":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display name of the posting period, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEP-2026"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"SEP-2026","nullable":true},"reversalDisplayValue":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Display name of the reversal period, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OCT-2026"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"OCT-2026","nullable":true},"waterfallStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of revenue waterfall (schedule) generation for the entry. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For approved entries this reflects the final waterfall; otherwise the preview waterfall."},"children":[]}]}]}],"example":"NEW","nullable":true},"errorCount":{"type":"integer","format":"int32","description":"Number of lines on the entry that currently have validation errors.","example":0,"nullable":true},"errorMessages":{"type":"array","items":{"type":"string"},"description":"Distinct validation error messages found on the entry's lines.","example":[],"nullable":true},"jeLines":{"type":"array","items":{"$ref":"#/components/schemas/JournalEntryLine"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lines of the entry, when included by the service. Use GET /journal-entries/{jeId}/lines for paginated access."},"children":[]}]}]}],"nullable":true},"glTransfer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the entry is transferred to the general ledger. Accepted values on input: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the service reports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when not set)."},"children":[]}]}]}],"example":"Yes","nullable":true},"orgName":{"type":"string","description":"Display name of the organization.","example":"US Operations","nullable":true},"bookName":{"type":"string","description":"Display name of the accounting book.","example":"Primary Book","nullable":true},"processType":{"type":"string","description":"Single-character code describing how the entry was created (for example from the UI or by upload). Informational.","example":"M","nullable":true},"jeStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Raw journal entry status as stored on the header. Same value set as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"New","nullable":true},"jeWaterfallStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the final waterfall generated after approval ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"NEW","nullable":true},"jeTempWaterfallStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the preview (temporary) waterfall generated before approval ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"NEW","nullable":true},"indicators":{"type":"string","description":"Internal flag string that stores header options such as GL transfer. Informational; do not parse.","nullable":true}}}},"components/schemas/JournalEntrySchedule":{"id":"components/schemas/JournalEntrySchedule","kind":"json-schema","title":"JournalEntrySchedule","data":{"type":"object","description":"One revenue schedule (accounting entry by period) generated from a journal entry.","properties":{"periodName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting period the schedule posts to, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEP-2026"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"SEP-2026","nullable":true},"accountType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue activity (account) type of the line, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Revenue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Contract Liability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Adjustment Revenue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"Revenue","nullable":true},"acountCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"General ledger account code of the schedule. (The property name is spelled "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"acountCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in responses; filters accept "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"acountCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":".)"},"children":[]}]}]}],"example":"1000-200-4000","nullable":true},"currencyCode":{"type":"string","description":"Transaction currency of the schedule.","example":"USD","nullable":true},"drAmount":{"type":"number","format":"double","description":"Debit amount in transaction currency.","example":1500,"nullable":true},"crAmount":{"type":"number","format":"double","description":"Credit amount in transaction currency.","example":0,"nullable":true},"funcDrAmount":{"type":"number","format":"double","description":"Debit amount in functional currency.","example":1500,"nullable":true},"funcCrAmount":{"type":"number","format":"double","description":"Credit amount in functional currency.","example":0,"nullable":true},"rcurrDrAmount":{"type":"number","format":"double","description":"Debit amount in reporting currency.","example":1500,"nullable":true},"rcurrCrAmount":{"type":"number","format":"double","description":"Credit amount in reporting currency.","example":0,"nullable":true},"schdRcId":{"type":"integer","format":"int64","description":"Revenue contract ID the schedule belongs to.","example":1001,"nullable":true},"interfaceFlag":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the schedule has been interfaced (transferred) to the GL ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"N","nullable":true}}}},"components/schemas/ErrorReason":{"id":"components/schemas/ErrorReason","kind":"json-schema","title":"ErrorReason","data":{"type":"object","description":"One reason why the request failed.","required":["code","message"],"properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-readable error code. See "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the complete list."},"children":[]}]}]}],"example":"INVALID_VALUE"},"message":{"type":"string","description":"Human-readable explanation of the failure. Safe to log; do not parse.","example":"Unknown field 'foo'. Allowed fields: categoryCode, createdBy, ..."},"field":{"type":"string","description":"Name of the request field that caused the error, when applicable.","example":"periodId","nullable":true}}}},"components/schemas/ErrorResponse":{"id":"components/schemas/ErrorResponse","kind":"json-schema","title":"ErrorResponse","data":{"type":"object","description":"Standard error envelope returned by the Manual Journal Entry API.","required":["success","reasons"],"properties":{"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for errors."},"children":[]}]}]}],"example":false},"reasons":{"type":"array","items":{"$ref":"#/components/schemas/ErrorReason"},"description":"One or more reasons for the failure."}}}},"components/schemas/PlatformErrorResponse":{"id":"components/schemas/PlatformErrorResponse","kind":"json-schema","title":"PlatformErrorResponse","data":{"type":"object","description":"Error body returned when a request is rejected before it reaches journal entry processing (for example access checks).","properties":{"timestamp":{"type":"string","format":"date-time","description":"Time the error occurred.","example":"2026-10-07T10:15:30.123+00:00","nullable":true},"status":{"type":"integer","format":"int32","description":"HTTP status code.","example":403,"nullable":true},"error":{"type":"string","description":"HTTP reason phrase.","example":"Forbidden","nullable":true},"message":{"type":"string","description":"Explanation of the failure.","example":"No message available","nullable":true},"path":{"type":"string","description":"Request path.","example":"/journal-entries","nullable":true}}}},"components/schemas/HealthCheckResponse":{"id":"components/schemas/HealthCheckResponse","kind":"json-schema","title":"HealthCheckResponse","data":{"type":"object","description":"Result of the availability check.","required":["success","status"],"properties":{"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the service is available."},"children":[]}]}]}],"example":true},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the journal entry processing service responded. (When it does not respond the API returns HTTP 502.)"},"children":[]}]}]}],"enum":["UP"],"example":"UP"},"target":{"type":"string","description":"Identifier of the component that was checked.","example":"mje-backend","nullable":true},"details":{"type":"string","description":"Optional detail, for example a failure summary.","nullable":true}}}},"components/schemas/JournalEntryHeaderInput":{"id":"components/schemas/JournalEntryHeaderInput","kind":"json-schema","title":"JournalEntryHeaderInput","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journal entry header supplied when creating an entry. Required fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bookId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"categoryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"functionalCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"glTransfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["name","orgId","bookId","periodId","categoryCode","sobId","functionalCurrency","exchangeRateType","accountMethod","glTransfer"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the journal entry. Shown in the Zuora Revenue UI and in GL interfaces. Must be meaningful to approvers, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEP-2026 Revenue Reclass"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required on create."},"children":[]}]}]}]}],"example":"SEP-2026 Revenue Reclass"},"bookId":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the accounting book (for example the primary book or a secondary/parallel book) the entry belongs to. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required on create."},"children":[]}]}]}]}],"example":1},"periodId":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the accounting (posting) period the journal entry is posted to. The period must be open. Retrieve valid IDs from GET /journal-entries/metadata/periods or GET /journal-entries/current-period. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required on create."},"children":[]}]}]}]}],"example":202609},"description":{"type":"string","description":"Free-text description of the journal entry's business purpose.","example":"Reclass deferred revenue for contract RC-1001","nullable":true},"categoryCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journal entry category code. Classifies why the entry is posted (for example an accrual, reclass or adjustment). Valid values are configured in your tenant's MANUAL_JOURNAL lookup; retrieve them from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"categoryId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required on create."},"children":[]}]}]}]}],"example":"RECLASS"},"exchangeRateType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exchange rate type used to convert transaction currency to functional and reporting currency (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Corporate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required on create."},"children":[]}]}]}]}],"example":"User"},"orgId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization (operating unit) identifier the entry belongs to, also called the security attribute value ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secAtrVal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required on create."},"children":[]}]}]}]}],"example":"101"},"sobName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the Set of Books. On create and update the service derives this from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; any value you send is overwritten."},"children":[]}]}]}],"example":"US Primary SOB","nullable":true},"sobId":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the Set of Books (SOB) the entry posts to. A Set of Books groups the ledger, functional currency and calendar used for accounting. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required on create."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Must match an existing Set of Books, otherwise the request fails with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_VALUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":1},"functionalCurrency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217 currency code of the functional (ledger) currency of the Set of Books, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required on create."},"children":[]}]}]}]}],"example":"USD"},"reversalPeriodId":{"type":"integer","format":"int64","description":"Identifier of the accounting period in which an automatic reversal of this entry is posted. Leave empty when the entry should not reverse.","example":202610,"nullable":true},"approvalCurrency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217 currency used to evaluate approval rules (thresholds) for this entry. Optional; valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approvalCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"USD","nullable":true},"glTransfer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the entry is transferred to the general ledger. Accepted values on input: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"No"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the service reports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Yes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when not set). "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required on create."},"children":[]}]}]}]}],"enum":["Yes","No"],"example":"Yes"},"revRecType":{"type":"string","description":"Revenue recognition type that drives the accounting method applied to the entry. Set on create only.","example":"STANDARD","nullable":true},"accountMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting method used to post the entry. Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountingMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required on create."},"children":[]}]}]}]}],"example":"Standard"}}}},"components/schemas/JournalEntryLineInput":{"id":"components/schemas/JournalEntryLineInput","kind":"json-schema","title":"JournalEntryLineInput","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One journal entry line supplied on create or full-file update. Required on every line: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeSetNo"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRateDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (> 0), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gexchangeRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (> 0) and at least one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"crAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":["jeSetNo","accountType","accountCode","currency","exchangeRateDate","exchangeRate","gexchangeRate"],"properties":{"id":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Existing line ID. Leave empty for new lines. On a full-file CSV update, lines with an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that matches an existing line are updated; lines without an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are inserted."},"children":[]}]}]}],"nullable":true},"jeSetNo":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set number that groups lines into a balanced set. Debits and credits within the same set number must net to zero. Use 1, 2, 3 ... to post several independent balanced sets in one entry. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required."},"children":[]}]}]}]}],"example":1},"accountCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"General ledger account code (accounting segments joined by your configured delimiter), for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000-200-4000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required."},"children":[]}]}]}]}],"example":"1000-200-4000"},"drAmount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Debit amount in transaction currency. Enter zero or a positive amount (negative values are rejected in CSV uploads). Provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"crAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or both) on every line."},"children":[]}]}]}],"example":1500,"nullable":true},"crAmount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credit amount in transaction currency. Enter zero or a positive amount (negative values are rejected in CSV uploads). Provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"crAmount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or both) on every line."},"children":[]}]}]}],"nullable":true},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217 transaction currency of the line amount. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required."},"children":[]}]}]}]}],"example":"USD"},"accountType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue activity (account) type of the line, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Revenue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Contract Liability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Adjustment Revenue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required."},"children":[]}]}]}]}],"example":"Contract Liability"},"startDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date of the revenue recognition period for the line. Accepted formats: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MMM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dd-MMM-yyyy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM/dd/yyyy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-09-01","nullable":true},"endDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date of the revenue recognition period for the line. Must be on or after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"2026-09-30","nullable":true},"reason":{"type":"string","description":"Reason code explaining the adjustment.","example":"RECLASS","nullable":true},"description":{"type":"string","description":"Free-text description of the line.","example":"Move deferred revenue to revenue","nullable":true},"exchangeRate":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Functional exchange rate: converts transaction currency to functional currency. Must be greater than 0. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the currencies are the same. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required."},"children":[]}]}]}]}],"example":1},"gexchangeRate":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Global (reporting) exchange rate: converts functional currency to the reporting currency. Must be greater than 0. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required."},"children":[]}]}]}]}],"example":1},"exchangeRateDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date the exchange rates apply to. Accepted formats: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MMM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dd-MMM-yyyy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MM/dd/yyyy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required."},"children":[]}]}]}]}],"example":"2026-09-30"},"soNum":{"type":"string","description":"Sales order (document) number the line relates to.","example":"SO-50012","nullable":true},"soLineId":{"type":"string","description":"Sales order (document) line identifier the line relates to.","example":"SO-50012-1","nullable":true},"rcId":{"type":"integer","format":"int64","description":"Revenue contract (RC) identifier the line relates to.","example":1001,"nullable":true},"rcLineId":{"type":"integer","format":"int64","description":"Revenue contract line identifier the line relates to.","example":50001,"nullable":true},"debitAccountType":{"type":"string","description":"Account type used for the debit side when a single line carries both sides.","nullable":true},"creditAccountType":{"type":"string","description":"Account type used for the credit side when a single line carries both sides.","nullable":true},"unbillAccounting":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unbilled accounting flag ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" posts the line to unbilled (contract asset/unbilled receivable) accounts."},"children":[]}]}]}],"enum":["Y","N"],"example":"N","nullable":true},"typeName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the cost type or variable consideration (VC) type when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a cost or VC account."},"children":[]}]}]}],"nullable":true},"costOrVcType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"typeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a cost type or a variable consideration type."},"children":[]}]}]}],"nullable":true},"comments":{"type":"string","description":"Free-text comments on the line.","nullable":true},"reference1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference3":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference4":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference5":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference6":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference7":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference8":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference8"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference9":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference10":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference11":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference11"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference12":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference12"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference13":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference13"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference14":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true},"reference15":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Customer-defined reference field. Use for your own identifiers (for example a ticket number or source-system key). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reference15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is one of 15 reference fields; your tenant may assign it a custom label (see GET /journal-entries/configurations)."},"children":[]}]}]}],"nullable":true}}}},"components/schemas/WaterfallEntriesPage":{"id":"components/schemas/WaterfallEntriesPage","kind":"json-schema","title":"WaterfallEntriesPage","data":{"type":"object","description":"A page of revenue waterfall entries.","properties":{"pageNumber":{"type":"integer","format":"int32","description":"1-based number of the page returned.","example":1,"nullable":true},"pageSize":{"type":"integer","format":"int32","description":"Maximum number of records per page (capped at 40).","example":20,"nullable":true},"totalRecords":{"type":"integer","format":"int64","description":"Total number of records that match the query across all pages.","example":1,"nullable":true},"result":{"type":"array","items":{"$ref":"#/components/schemas/WaterfallEntry"},"description":"Records on this page.","nullable":true}}}},"components/schemas/QueryFilter":{"id":"components/schemas/QueryFilter","kind":"json-schema","title":"QueryFilter","data":{"type":"object","description":"One filter condition in a request body (POST /query and export endpoints).","required":["fieldName","operator"],"properties":{"fieldName":{"type":"string","description":"Field to filter on. See the allowed field list of the endpoint.","example":"status"},"operator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison operator. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for text values (values are quoted automatically). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIKE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accepts "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" wildcards."},"children":[]}]}]}],"enum":["IN","NOT IN","=","<>","<","<=",">",">=","LIKE","NOT LIKE","IS NULL","IS NOT NULL"],"example":"IN"},"values":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values to compare against. Supply one value for scalar operators and one or more for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT IN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must contain at least one element for every operator."},"children":[]}]}]}],"example":["New","Validated"],"nullable":true}}}},"components/schemas/QueryOrder":{"id":"components/schemas/QueryOrder","kind":"json-schema","title":"QueryOrder","data":{"type":"object","description":"Sort order in a request body.","required":["fieldName","orderBy"],"properties":{"fieldName":{"type":"string","description":"Field to sort by.","example":"createdDate"},"orderBy":{"type":"string","description":"Sort direction.","enum":["ASC","DESC"],"example":"DESC"}}}},"components/schemas/QueryRequest":{"id":"components/schemas/QueryRequest","kind":"json-schema","title":"QueryRequest","data":{"type":"object","description":"Filter, sort and paging criteria sent in a request body.","properties":{"pageNumber":{"type":"integer","format":"int32","description":"1-based page number. Defaults to 1.","example":1,"nullable":true},"pageSize":{"type":"integer","format":"int32","description":"Records per page. Defaults to 20; values above 40 are reduced to 40. Not applied by export endpoints, which return all rows.","example":20,"nullable":true},"filters":{"type":"array","items":{"$ref":"#/components/schemas/QueryFilter"},"description":"Filter conditions, combined with AND.","nullable":true},"ordering":{"allOf":[{"$ref":"#/components/schemas/QueryOrder"}],"description":"Single sort order."}}}},"components/schemas/WaterfallEntry":{"id":"components/schemas/WaterfallEntry","kind":"json-schema","title":"WaterfallEntry","data":{"type":"object","description":"One row of the revenue waterfall produced by a journal entry: the amount scheduled to each period for a line.","properties":{"jeSetNo":{"type":"string","description":"Set number that groups lines into a balanced set. Debits and credits within the same set number must net to zero. Use 1, 2, 3 ... to post several independent balanced sets in one entry.","example":"1","nullable":true},"soNumber":{"type":"string","description":"Sales order (document) number the line relates to.","example":"SO-50012","nullable":true},"soLineId":{"type":"string","description":"Sales order (document) line identifier the line relates to.","example":"SO-50012-1","nullable":true},"accountCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"General ledger account code (accounting segments joined by your configured delimiter), for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000-200-4000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"1000-200-4000","nullable":true},"jeAmount":{"type":"number","format":"double","description":"Journal entry amount of the line being spread.","example":1500,"nullable":true},"startDate":{"type":"string","format":"date-time","description":"Recognition start date.","example":"2026-09-01T00:00:00.000+00:00","nullable":true},"endDate":{"type":"string","format":"date-time","description":"Recognition end date.","example":"2026-11-30T00:00:00.000+00:00","nullable":true},"accountType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue activity (account) type of the line, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Revenue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Contract Liability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Adjustment Revenue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Valid values come from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in GET /journal-entries/metadata."},"children":[]}]}]}],"example":"Revenue","nullable":true},"entries":{"type":"object","additionalProperties":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount per period, keyed by period name (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEP-2026"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Values are returned as strings."},"children":[]}]}]}],"example":{"SEP-2026":"500.00","OCT-2026":"500.00","NOV-2026":"500.00"},"nullable":true}}}},"components/schemas/WaterfallStatusResponse":{"id":"components/schemas/WaterfallStatusResponse","kind":"json-schema","title":"WaterfallStatusResponse","data":{"type":"object","description":"Waterfall generation status of a journal entry.","properties":{"id":{"type":"integer","format":"int64","description":"Unique system-generated identifier of the journal entry (JE header ID).","example":10045,"nullable":true},"waterfallStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of revenue waterfall (schedule) generation for the entry. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For approved entries this reflects the final waterfall; otherwise the preview waterfall."},"children":[]}]}]}],"enum":["NEW","IN PROGRESS","SUCCESS","ERROR"],"example":"SUCCESS","nullable":true}}}},"components/schemas/ValidationStatusResponse":{"id":"components/schemas/ValidationStatusResponse","kind":"json-schema","title":"ValidationStatusResponse","data":{"type":"object","description":"Validation status of a journal entry.","properties":{"id":{"type":"integer","format":"int64","description":"Unique system-generated identifier of the journal entry (JE header ID).","example":10045,"nullable":true},"validationStatus":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Progress of line validation. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"New"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Validation In Progress"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Validated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Validated","nullable":true}}}},"components/schemas/StatusRequest":{"id":"components/schemas/StatusRequest","kind":"json-schema","title":"StatusRequest","data":{"type":"object","description":"Request body for workflow actions (approve, reject, recall, reverse, bulk delete) and submit.","properties":{"jeIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDs of the journal entries to act on. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for approve, reject, recall, reverse and bulk-delete. Reverse accepts exactly one ID. Ignored by submit (the ID comes from the path)."},"children":[]}]}]}],"example":[10045,10046],"nullable":true},"comment":{"type":"string","description":"Comment recorded in the audit trail with the action.","example":"Approved for September close","nullable":true},"bookId":{"type":"integer","format":"int32","description":"Identifier of the accounting book (for example the primary book or a secondary/parallel book) the entry belongs to. Optional.","example":1,"nullable":true},"reversalPeriod":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period ID in which the reversal is posted. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required for reverse"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; ignored by other actions."},"children":[]}]}]}],"example":202610,"nullable":true}}}},"components/schemas/BulkActionItem":{"id":"components/schemas/BulkActionItem","kind":"json-schema","title":"BulkActionItem","data":{"type":"object","description":"Outcome for one journal entry in a workflow action.","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journal entry ID, when reported by the service. Workflow actions currently identify the entry inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"10045","nullable":true},"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the action succeeded for this entry."},"children":[]}]}]}],"example":true},"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUSINESS_RULE_VIOLATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the action was refused for this entry; omitted on success."},"children":[]}]}]}],"nullable":true},"message":{"type":"string","description":"Result message for the entry.","example":"Journal entry 10045 approved successfully","nullable":true}}}},"components/schemas/BulkActionResponse":{"id":"components/schemas/BulkActionResponse","kind":"json-schema","title":"BulkActionResponse","data":{"type":"object","description":"Outcome of a workflow action. Returned with HTTP 200 when every entry has the same outcome and HTTP 207 when some entries succeeded and others failed.","properties":{"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only when the action succeeded for every entry."},"children":[]}]}]}],"example":true},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Journal entry status after the action as reported by the service (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after approve, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Rejected"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after reject, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after submit); for reverse, the reversal status. May be omitted (for example bulk delete)."},"children":[]}]}]}],"example":"Approved","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/BulkActionItem"},"description":"Per-entry outcomes.","nullable":true}}}},"components/schemas/PrivilegesRequest":{"id":"components/schemas/PrivilegesRequest","kind":"json-schema","title":"PrivilegesRequest","data":{"type":"object","description":"Entries to evaluate privileges for.","required":["jeIds"],"properties":{"jeIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Journal entry IDs to evaluate. Privileges are returned for the combined selection.","example":[10045]},"bookId":{"type":"integer","format":"int32","description":"Identifier of the accounting book (for example the primary book or a secondary/parallel book) the entry belongs to.","example":1,"nullable":true}}}},"components/schemas/Privileges":{"id":"components/schemas/Privileges","kind":"json-schema","title":"Privileges","data":{"type":"object","description":"Which actions the caller may currently perform on the selected entries, considering entry status, approval rules, soft freeze and the caller's role.","properties":{"submitAllowed":{"type":"boolean","description":"Caller can submit the entries for approval.","example":true,"nullable":true},"approveAllowed":{"type":"boolean","description":"Caller can approve the entries.","example":false,"nullable":true},"rejectAllowed":{"type":"boolean","description":"Caller can reject the entries.","example":false,"nullable":true},"recallAllowed":{"type":"boolean","description":"Caller can recall the entries from approval.","example":false,"nullable":true},"deleteAllowed":{"type":"boolean","description":"Caller can delete the entries.","example":true,"nullable":true},"updateAllowed":{"type":"boolean","description":"Caller can edit the entries.","example":true,"nullable":true},"revertAllowed":{"type":"boolean","description":"Caller can reverse the entries.","example":false,"nullable":true}}}},"components/schemas/AuditEvent":{"id":"components/schemas/AuditEvent","kind":"json-schema","title":"AuditEvent","data":{"type":"object","description":"One audit-trail event for a journal entry.","properties":{"id":{"type":"integer","format":"int64","description":"Audit event ID.","example":900001,"nullable":true},"action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action recorded. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUBMIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"SUBMIT","nullable":true},"headerId":{"type":"integer","format":"int64","description":"Identifier of the journal entry (header) this record belongs to.","example":10045,"nullable":true},"lineId":{"type":"integer","format":"int64","description":"Line ID when the event concerns a single line.","nullable":true},"comments":{"type":"string","description":"Comment entered with the action.","example":"Ready for review","nullable":true},"bookId":{"type":"integer","format":"int32","description":"Identifier of the accounting book (for example the primary book or a secondary/parallel book) the entry belongs to.","example":1,"nullable":true},"clientId":{"type":"integer","format":"int32","description":"Identifier of your Zuora Revenue client (tenant partition). Informational.","example":1,"nullable":true},"createdPeriodId":{"type":"integer","format":"int32","description":"Period ID that was open when the event was recorded.","example":202609,"nullable":true},"createdBy":{"type":"string","description":"User who performed the action.","example":"jane.doe@example.com","nullable":true},"createdDate":{"type":"string","description":"When the action was performed.","example":"2026-09-28 11:02:44","nullable":true},"updatedBy":{"type":"string","description":"User who last updated the record.","example":"jane.doe@example.com","nullable":true},"updatedDate":{"type":"string","description":"Timestamp when the record was last updated (ISO 8601).","example":"2026-09-28 11:02:44","nullable":true},"secAtrValue":{"type":"string","description":"Organization (security attribute value) of the entry.","example":"101","nullable":true}}}},"components/schemas/MetadataOption":{"id":"components/schemas/MetadataOption","kind":"json-schema","title":"MetadataOption","data":{"type":"object","description":"An ID/name option.","properties":{"id":{"type":"integer","format":"int32","description":"Option identifier (for example a period ID, book ID or org ID).","example":202609,"nullable":true},"name":{"type":"string","description":"Display name.","example":"SEP-2026","nullable":true}}}},"components/schemas/MetadataKeyValue":{"id":"components/schemas/MetadataKeyValue","kind":"json-schema","title":"MetadataKeyValue","data":{"type":"object","description":"A code/display-value option.","properties":{"key":{"type":"string","description":"Code to send in requests.","example":"RECLASS","nullable":true},"value":{"type":"string","description":"Display value.","example":"Reclassification","nullable":true}}}},"components/schemas/Metadata":{"id":"components/schemas/Metadata","kind":"json-schema","title":"Metadata","data":{"type":"object","description":"Lists of valid values used to build journal entries. GET /metadata returns tenant-wide lists; GET /metadata/periods returns the period lists for a book and organization.","properties":{"postingPeriod":{"type":"array","items":{"$ref":"#/components/schemas/MetadataOption"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Open periods an entry can be posted to ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"nullable":true},"reversalPeriod":{"type":"array","items":{"$ref":"#/components/schemas/MetadataOption"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Periods that can be used as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversalPeriodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"createDate":{"type":"string","description":"Current date in the service time zone.","example":"2026-10-07","nullable":true},"bookId":{"type":"array","items":{"$ref":"#/components/schemas/MetadataOption"},"description":"Accounting books available to the caller.","nullable":true},"categoryId":{"type":"array","items":{"$ref":"#/components/schemas/MetadataKeyValue"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"categoryCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]}],"nullable":true},"exchangeRates":{"type":"array","items":{"$ref":"#/components/schemas/MetadataKeyValue"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exchangeRateType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]}],"nullable":true},"approvalCurrency":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"approvalCurrency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]}],"example":["USD","EUR"],"nullable":true},"sobName":{"type":"array","items":{"type":"string"},"description":"Set of Books names.","example":["US Primary SOB"],"nullable":true},"orgId":{"type":"array","items":{"$ref":"#/components/schemas/MetadataOption"},"description":"Organizations available to the caller.","nullable":true},"functionalCurrency":{"type":"array","items":{"type":"string"},"description":"Functional currencies.","example":["USD"],"nullable":true},"glTransfer":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"glTransfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]}],"example":["YES","NO"],"nullable":true},"accountingMethod":{"type":"array","items":{"$ref":"#/components/schemas/MetadataKeyValue"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountMethod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]}],"nullable":true},"accountTypes":{"type":"array","items":{"$ref":"#/components/schemas/MetadataKeyValue"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid line "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]}],"nullable":true},"accountingSegments":{"type":"array","items":{"$ref":"#/components/schemas/MetadataKeyValue"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting segment definitions used to build "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accountCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"vcTypes":{"type":"array","items":{"$ref":"#/components/schemas/MetadataKeyValue"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variable consideration types (for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"typeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the account type is a VC account)."},"children":[]}]}]}],"nullable":true},"costTypes":{"type":"array","items":{"$ref":"#/components/schemas/MetadataKeyValue"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost types (for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"typeName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the account type is a cost account)."},"children":[]}]}]}],"nullable":true}}}},"components/schemas/ConfigurationField":{"id":"components/schemas/ConfigurationField","kind":"json-schema","title":"ConfigurationField","data":{"type":"object","description":"One configurable journal entry field.","properties":{"code":{"type":"string","description":"Field code.","example":"REFERENCE1","nullable":true},"value":{"type":"string","description":"Label configured for the field in your tenant.","example":"Ticket Number","nullable":true},"sequence":{"type":"integer","format":"int32","description":"Display order.","example":29,"nullable":true}}}},"components/schemas/Configurations":{"id":"components/schemas/Configurations","kind":"json-schema","title":"Configurations","data":{"type":"object","description":"Tenant-specific field configuration (for example custom labels for reference fields).","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/ConfigurationField"},"description":"Configured fields.","nullable":true}}}},"components/schemas/CurrentPeriod":{"id":"components/schemas/CurrentPeriod","kind":"json-schema","title":"CurrentPeriod","data":{"type":"object","description":"The current open accounting period.","properties":{"periodId":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Period ID to use as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":202610,"nullable":true},"periodDisplayValue":{"type":"string","description":"Period display name.","example":"OCT-2026","nullable":true}}}},"components/schemas/SummaryValue":{"id":"components/schemas/SummaryValue","kind":"json-schema","title":"SummaryValue","data":{"type":"object","description":"Debit/credit totals of a journal entry for one currency type.","properties":{"currencyType":{"type":"string","description":"Which currency the totals are in: transaction, functional or reporting.","example":"Transaction","nullable":true},"currency":{"type":"string","description":"ISO 4217 currency code.","example":"USD","nullable":true},"drAmt":{"type":"string","description":"Total debits (formatted string).","example":"1500.00","nullable":true},"crAmt":{"type":"string","description":"Total credits (formatted string).","example":"1500.00","nullable":true},"netAmt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Debits minus credits. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0.00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a balanced entry."},"children":[]}]}]}],"example":"0.00","nullable":true}}}},"components/schemas/SoftFreeze":{"id":"components/schemas/SoftFreeze","kind":"json-schema","title":"SoftFreeze","data":{"type":"object","description":"Soft-freeze state for a book and organization. While a soft freeze is applied (typically during period close), journal entry changes are restricted.","properties":{"bookId":{"type":"integer","format":"int32","description":"Identifier of the accounting book (for example the primary book or a secondary/parallel book) the entry belongs to.","example":1,"nullable":true},"secAtrVal":{"type":"string","description":"Organization (security attribute value).","example":"101","nullable":true},"softFreezeApplied":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when a soft freeze is in effect."},"children":[]}]}]}],"example":false,"nullable":true}}}},"components/schemas/UserRole":{"id":"components/schemas/UserRole","kind":"json-schema","title":"UserRole","data":{"type":"object","description":"The caller's level of access to manual journal entries.","properties":{"role":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FULL_ACCESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (create, edit and act on entries), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READ_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (view only) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["FULL_ACCESS","READ_ONLY","NONE"],"example":"FULL_ACCESS","nullable":true}}}},"components/schemas/DescribeColumn":{"id":"components/schemas/DescribeColumn","kind":"json-schema","title":"DescribeColumn","data":{"type":"object","description":"Description of one column of a journal entry object.","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Column name. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeHead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" this is the API property name; for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeLine"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it is the CSV template column code."},"children":[]}]}]}],"example":"DR_SEGMENTS","nullable":true},"label":{"type":"string","description":"Display label (tenant overrides applied for configurable line fields).","example":"Account Code","nullable":true},"dataType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"string"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["string","number","date","id"],"example":"string","nullable":true},"sequence":{"type":"integer","format":"int32","description":"Display/template order.","example":3,"nullable":true}}}},"components/schemas/DescribeObject":{"id":"components/schemas/DescribeObject","kind":"json-schema","title":"DescribeObject","data":{"type":"object","description":"Column list of one object.","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/DescribeColumn"},"description":"Columns in display order.","nullable":true}}}},"components/schemas/DescribeResponse":{"id":"components/schemas/DescribeResponse","kind":"json-schema","title":"DescribeResponse","data":{"type":"object","description":"Column catalog of the journal entry objects.","properties":{"objects":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DescribeObject"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Map keyed by object name: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeHead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (header), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeLine"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (line) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (schedule)."},"children":[]}]}]}],"nullable":true}}}},"components/schemas/Attachment":{"id":"components/schemas/Attachment","kind":"json-schema","title":"Attachment","data":{"type":"object","description":"A note or file attached to a journal entry.","properties":{"id":{"type":"integer","format":"int32","description":"Attachment ID.","example":501,"nullable":true},"fileName":{"type":"string","description":"Original file name.","example":"support.xlsx","nullable":true},"comments":{"type":"string","description":"Note entered with the attachment.","example":"Supporting calculation","nullable":true},"addLink":{"type":"string","description":"Optional URL stored with the attachment (for example a link to a document system).","example":"https://example.com/docs/123","nullable":true},"jeId":{"type":"integer","format":"int32","description":"Identifier of the journal entry (header) this record belongs to.","example":10045,"nullable":true},"bookId":{"type":"integer","format":"int32","description":"Identifier of the accounting book (for example the primary book or a secondary/parallel book) the entry belongs to.","example":1,"nullable":true},"contentType":{"type":"string","description":"MIME type of the file.","example":"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","nullable":true},"fileSize":{"type":"integer","format":"int64","description":"File size in bytes.","example":18432,"nullable":true},"body":{"type":"string","format":"byte","description":"File content (Base64). Normally empty in list responses; use the download endpoint.","nullable":true},"crtdBy":{"type":"string","description":"User who uploaded the attachment.","example":"jane.doe@example.com","nullable":true},"crtdDt":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload time ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-ddTHH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"2026-09-28T11:05:00","nullable":true}}}},"components/schemas/AttachmentUploadRequest":{"id":"components/schemas/AttachmentUploadRequest","kind":"json-schema","title":"AttachmentUploadRequest","data":{"type":"object","description":"Multipart form for uploading an attachment.","properties":{"file":{"type":"string","format":"binary","description":"File to attach (up to 100 MB).","nullable":true}}}},"components/schemas/AttachmentUploadResponse":{"id":"components/schemas/AttachmentUploadResponse","kind":"json-schema","title":"AttachmentUploadResponse","data":{"type":"object","description":"Result of an attachment upload.","properties":{"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["success","failure"],"example":"success","nullable":true},"message":{"type":"string","description":"Result message.","example":"Notes/Attachments are successfully uploaded","nullable":true}}}},"components/schemas/AttachmentDownloadUrl":{"id":"components/schemas/AttachmentDownloadUrl","kind":"json-schema","title":"AttachmentDownloadUrl","data":{"type":"object","description":"Short-lived presigned URL for downloading the attachment.","properties":{"url":{"type":"string","format":"uri","description":"Presigned HTTPS URL. Download with a plain GET without the Authorization header. The URL expires after a short time; request a new one if it has expired.","example":"https://zr-attachments.s3.amazonaws.com/...&X-Amz-Signature=...","nullable":true}}}},"components/schemas/RcRedirection":{"id":"components/schemas/RcRedirection","kind":"json-schema","title":"RcRedirection","data":{"type":"object","description":"Revenue contract lookup result.","properties":{"rcId":{"type":"integer","format":"int32","description":"Revenue contract ID that contains the given RC, sales order or line.","example":1001,"nullable":true},"retCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return code from the lookup. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or empty) indicates success."},"children":[]}]}]}],"example":"0","nullable":true},"errMsg":{"type":"string","description":"Error message when the lookup failed.","nullable":true}}}},"components/schemas/MjeGatewayError":{"id":"components/schemas/MjeGatewayError","kind":"json-schema","title":"MjeGatewayError","data":{"type":"object","description":"Error body produced by the Zuora API gateway (authentication and rate limiting). The exact body is set by the gateway.","properties":{"message":{"type":"string","description":"Explanation of the failure.","example":"Authentication error"}}}},"components/schemas/ManualActionResponse":{"id":"components/schemas/ManualActionResponse","kind":"json-schema","title":"ManualActionResponse","data":{"type":"object","description":"Result of a manual action.","required":["success","processId"],"properties":{"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the action completed. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the revenue engine rejected it under a business rule; see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"processId":{"type":"string","description":"Unique ID generated for this request. Quote it when you contact Zuora Global Support."},"message":{"type":"string","description":"Result message from the revenue engine. May be empty on success."},"changeIds":{"type":"string","description":"Comma-separated IDs of records changed by the action, when the action reports them. Omitted otherwise."}}}},"components/schemas/HoldRecord":{"id":"components/schemas/HoldRecord","kind":"json-schema","title":"HoldRecord","data":{"type":"object","description":"A hold record created by the apply-hold action.","properties":{"id":{"type":"integer","format":"int64","description":"ID of the applied-hold record."},"rcId":{"type":"integer","format":"int64","description":"Revenue contract ID."},"lineId":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Line the hold was applied to. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the hold is not line-level."},"children":[]}]}]}]},"rcPobId":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POB the hold was applied to. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the hold is not POB-level."},"children":[]}]}]}]},"revHoldId":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hold definition ID (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the path)."},"children":[]}]}]}]},"bookId":{"type":"integer","format":"int64","description":"Revenue book."},"comments":{"type":"string","description":"Hold comment."}}}},"components/schemas/ApplyHoldResponse":{"id":"components/schemas/ApplyHoldResponse","kind":"json-schema","title":"ApplyHoldResponse","data":{"allOf":[{"$ref":"#/components/schemas/ManualActionResponse"},{"type":"object","properties":{"holdRecords":{"type":"array","items":{"$ref":"#/components/schemas/HoldRecord"},"description":"Hold records created by the action. Omitted when none were created."}}}]}},"components/schemas/RcLineAdjustmentRecord":{"id":"components/schemas/RcLineAdjustmentRecord","kind":"json-schema","title":"RcLineAdjustmentRecord","data":{"type":"object","description":"Line price adjustment created by applying variable consideration.","properties":{"id":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Line price adjustment ID. Pass it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcLinePriceAdjustmentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to expire the variable consideration."},"children":[]}]}]}]},"lineId":{"type":"integer","format":"int64","description":"Revenue contract line ID."},"rcId":{"type":"integer","format":"int64","description":"Revenue contract ID."},"bookId":{"type":"integer","format":"int64","description":"Revenue book."},"vcTypeId":{"type":"integer","format":"int64","description":"Variable consideration type ID."}}}},"components/schemas/ApplyVcResponse":{"id":"components/schemas/ApplyVcResponse","kind":"json-schema","title":"ApplyVcResponse","data":{"allOf":[{"$ref":"#/components/schemas/ManualActionResponse"},{"type":"object","properties":{"rcLineAdjustmentRecords":{"type":"array","items":{"$ref":"#/components/schemas/RcLineAdjustmentRecord"},"description":"Price adjustments created. Omitted when none were created (for example on a dry run)."},"previewData":{"type":"string","description":"Preview of the adjustment returned on a dry run. Omitted when the engine returns none."}}}]}},"components/schemas/VcType":{"id":"components/schemas/VcType","kind":"json-schema","title":"VcType","data":{"type":"object","description":"A variable consideration type that can be applied to the line.","properties":{"id":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variable consideration type ID. Pass it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vcTypeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to apply variable consideration."},"children":[]}]}]}]},"value":{"type":"string","description":"Variable consideration type name."}}}},"components/schemas/RcErrorReason":{"id":"components/schemas/RcErrorReason","kind":"json-schema","title":"RcErrorReason","data":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error code. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ValidationError"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"InvalidRequest"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NotFound"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" come from request checks. Upper-case codes such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNAVAILABLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" come from the revenue engine. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SystemError"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an unexpected failure."},"children":[]}]}]}]},"message":{"type":"string","description":"Human-readable description of the problem."}}}},"components/schemas/ClientErrorResponse":{"id":"components/schemas/ClientErrorResponse","kind":"json-schema","title":"ClientErrorResponse","data":{"type":"object","description":"Error returned for 4xx responses.","required":["success","reasons"],"properties":{"success":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"processId":{"type":"string","description":"Unique ID generated for this request."},"requestId":{"type":"string","description":"Unique ID of the failed request. Quote it when you contact Zuora Global Support."},"reasons":{"type":"array","items":{"$ref":"#/components/schemas/RcErrorReason"},"description":"One entry per problem."}}}},"components/schemas/ServerErrorResponse":{"id":"components/schemas/ServerErrorResponse","kind":"json-schema","title":"ServerErrorResponse","data":{"type":"object","description":"Error returned for 5xx responses.","required":["reasons"],"properties":{"reasons":{"type":"array","items":{"$ref":"#/components/schemas/RcErrorReason"}}}}},"components/schemas/OpenCloseRcRequest":{"id":"components/schemas/OpenCloseRcRequest","kind":"json-schema","title":"OpenCloseRcRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Body for opening or closing a contract. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use the current contract version."},"children":[]}]}]}],"properties":{"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/UnfreezeRcRequest":{"id":"components/schemas/UnfreezeRcRequest","kind":"json-schema","title":"UnfreezeRcRequest","data":{"type":"object","required":["action"],"properties":{"action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unfreeze action to perform. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNFREEZE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"UNFREEZE"},"changeModDate":{"type":"string","description":"Whether to update the contract modification date as part of the unfreeze.","enum":["Y","N"],"default":"Y"},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/ApplyHoldRcRequest":{"id":"components/schemas/ApplyHoldRcRequest","kind":"json-schema","title":"ApplyHoldRcRequest","data":{"type":"object","properties":{"comments":{"type":"string","description":"Comment stored with the hold.","default":""},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/HoldLine":{"id":"components/schemas/HoldLine","kind":"json-schema","title":"HoldLine","data":{"type":"object","description":"Item to put on hold. Supply the identifier that matches the hold level of the endpoint.","properties":{"lineId":{"type":"integer","format":"int64","description":"Revenue contract line ID. Required for line-level holds."},"rcPobId":{"type":"integer","format":"int64","description":"POB ID. Required for POB-level holds."},"chargeNumber":{"type":"string","description":"Zuora Billing charge number. Required for charge-level holds."},"holdComments":{"type":"string","description":"Comment for this item.","default":""}}}},"components/schemas/ApplyHoldItemsRequest":{"id":"components/schemas/ApplyHoldItemsRequest","kind":"json-schema","title":"ApplyHoldItemsRequest","data":{"type":"object","required":["lines"],"properties":{"comments":{"type":"string","description":"Comment stored with the hold.","default":""},"lines":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/HoldLine"},"description":"Items to put on hold."},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/ReleaseHoldRcRequest":{"id":"components/schemas/ReleaseHoldRcRequest","kind":"json-schema","title":"ReleaseHoldRcRequest","data":{"type":"object","properties":{"comments":{"type":"string","description":"Release comment.","default":""},"reason":{"type":"string","description":"Release reason.","default":""},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/ReleaseHoldItem":{"id":"components/schemas/ReleaseHoldItem","kind":"json-schema","title":"ReleaseHoldItem","data":{"type":"object","description":"Item to release. Supply the identifier that matches the hold level of the endpoint.","properties":{"lineId":{"type":"integer","format":"int64","description":"Revenue contract line ID. Required for line-level releases."},"rcPobId":{"type":"integer","format":"int64","description":"POB ID. Required for POB-level releases."},"chargeNumber":{"type":"string","description":"Zuora Billing charge number. Required for charge-level releases."},"releaseComments":{"type":"string","description":"Release comment for this item.","default":""},"releaseReason":{"type":"string","description":"Release reason for this item.","default":""}}}},"components/schemas/ReleaseHoldItemsRequest":{"id":"components/schemas/ReleaseHoldItemsRequest","kind":"json-schema","title":"ReleaseHoldItemsRequest","data":{"type":"object","required":["items"],"properties":{"comments":{"type":"string","description":"Release comment.","default":""},"reason":{"type":"string","description":"Release reason.","default":""},"items":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ReleaseHoldItem"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items to release. Note that this field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", while apply-hold uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lines"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/DeferReleaseRevenueRcRequest":{"id":"components/schemas/DeferReleaseRevenueRcRequest","kind":"json-schema","title":"DeferReleaseRevenueRcRequest","data":{"type":"object","required":["comments"],"properties":{"comments":{"type":"string","description":"Reason for the action, recorded in the audit history.","minLength":1},"startDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the date window the action applies to ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date"},"endDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End of the date window the action applies to ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date"},"releaseAmount":{"type":"number","format":"double","description":"Amount to release. Used by release actions for a partial release."},"releasePercentage":{"type":"number","format":"double","description":"Percentage to release. Used by release actions for a partial release."},"contProsType":{"type":"string","description":"Contingency processing type code configured in your tenant.","default":""},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5},"rcPobIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Limit the action to these POBs. Omit to act on the whole contract."}}}},"components/schemas/DeferReleaseRevenuePobRequest":{"id":"components/schemas/DeferReleaseRevenuePobRequest","kind":"json-schema","title":"DeferReleaseRevenuePobRequest","data":{"type":"object","required":["comments"],"properties":{"comments":{"type":"string","description":"Reason for the action, recorded in the audit history.","minLength":1},"startDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start of the date window the action applies to ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date"},"endDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End of the date window the action applies to ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date"},"releaseAmount":{"type":"number","format":"double","description":"Amount to release. Used by release actions for a partial release."},"releasePercentage":{"type":"number","format":"double","description":"Percentage to release. Used by release actions for a partial release."},"contProsType":{"type":"string","description":"Contingency processing type code configured in your tenant.","default":""},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/DeferReleaseCostRequest":{"id":"components/schemas/DeferReleaseCostRequest","kind":"json-schema","title":"DeferReleaseCostRequest","data":{"type":"object","required":["lineId","costTypeId","comments"],"properties":{"lineId":{"type":"integer","format":"int64","description":"Revenue contract line that carries the cost."},"costTypeId":{"type":"integer","format":"int64","description":"Cost type ID configured in your tenant (for example commissions)."},"comments":{"type":"string","description":"Reason for the action, recorded in the audit history.","minLength":1},"releaseAmount":{"type":"number","format":"double","description":"Amount of cost to release."},"releasePercentage":{"type":"number","format":"double","description":"Percentage of cost to release."},"releaseQuantity":{"type":"integer","format":"int32","description":"Quantity of cost to release."},"ruleStartDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date of the cost amortization rule ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"default":""},"ruleEndDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date of the cost amortization rule ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"default":""},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/AllocateActionRequest":{"id":"components/schemas/AllocateActionRequest","kind":"json-schema","title":"AllocateActionRequest","data":{"type":"object","required":["action"],"properties":{"action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allocation action. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REALLOCATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" re-runs the allocation of the transaction price across the contract's POBs. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALLOCATION_ELIGIBLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" marks the contract as eligible for allocation. Values are case-sensitive."},"children":[]}]}]}],"enum":["REALLOCATE","ALLOCATION_ELIGIBLE"]},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/SwitchAllocationRequest":{"id":"components/schemas/SwitchAllocationRequest","kind":"json-schema","title":"SwitchAllocationRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use the current version."},"children":[]}]}]}],"properties":{"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/EditLineRequest":{"id":"components/schemas/EditLineRequest","kind":"json-schema","title":"EditLineRequest","data":{"type":"object","description":"Only the attributes you send are changed. Omitted attributes keep their value.","required":["comments"],"properties":{"comments":{"type":"string","description":"Reason for the edit, recorded in the audit history.","minLength":1},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5},"atr1":{"type":"string","description":"Custom text attribute 1."},"atr2":{"type":"string","description":"Custom text attribute 2."},"atr3":{"type":"string","description":"Custom text attribute 3."},"atr4":{"type":"string","description":"Custom text attribute 4."},"atr5":{"type":"string","description":"Custom text attribute 5."},"atr6":{"type":"string","description":"Custom text attribute 6."},"atr7":{"type":"string","description":"Custom text attribute 7."},"atr8":{"type":"string","description":"Custom text attribute 8."},"atr9":{"type":"string","description":"Custom text attribute 9."},"atr10":{"type":"string","description":"Custom text attribute 10."},"atr11":{"type":"string","description":"Custom text attribute 11."},"atr12":{"type":"string","description":"Custom text attribute 12."},"atr13":{"type":"string","description":"Custom text attribute 13."},"atr14":{"type":"string","description":"Custom text attribute 14."},"atr15":{"type":"string","description":"Custom text attribute 15."},"atr16":{"type":"string","description":"Custom text attribute 16."},"atr17":{"type":"string","description":"Custom text attribute 17."},"atr18":{"type":"string","description":"Custom text attribute 18."},"atr19":{"type":"string","description":"Custom text attribute 19."},"atr20":{"type":"string","description":"Custom text attribute 20."},"atr21":{"type":"string","description":"Custom text attribute 21."},"atr22":{"type":"string","description":"Custom text attribute 22."},"atr23":{"type":"string","description":"Custom text attribute 23."},"atr24":{"type":"string","description":"Custom text attribute 24."},"atr25":{"type":"string","description":"Custom text attribute 25."},"atr26":{"type":"string","description":"Custom text attribute 26."},"atr27":{"type":"string","description":"Custom text attribute 27."},"atr28":{"type":"string","description":"Custom text attribute 28."},"atr29":{"type":"string","description":"Custom text attribute 29."},"atr30":{"type":"string","description":"Custom text attribute 30."},"atr31":{"type":"string","description":"Custom text attribute 31."},"atr32":{"type":"string","description":"Custom text attribute 32."},"atr33":{"type":"string","description":"Custom text attribute 33."},"atr34":{"type":"string","description":"Custom text attribute 34."},"atr35":{"type":"string","description":"Custom text attribute 35."},"atr36":{"type":"string","description":"Custom text attribute 36."},"atr37":{"type":"string","description":"Custom text attribute 37."},"atr38":{"type":"string","description":"Custom text attribute 38."},"atr39":{"type":"string","description":"Custom text attribute 39."},"atr40":{"type":"string","description":"Custom text attribute 40."},"atr41":{"type":"string","description":"Custom text attribute 41."},"atr42":{"type":"string","description":"Custom text attribute 42."},"atr43":{"type":"string","description":"Custom text attribute 43."},"atr44":{"type":"string","description":"Custom text attribute 44."},"atr45":{"type":"string","description":"Custom text attribute 45."},"atr46":{"type":"string","description":"Custom text attribute 46."},"atr47":{"type":"string","description":"Custom text attribute 47."},"atr48":{"type":"string","description":"Custom text attribute 48."},"atr49":{"type":"string","description":"Custom text attribute 49."},"atr50":{"type":"string","description":"Custom text attribute 50."},"atr51":{"type":"string","description":"Custom text attribute 51."},"atr52":{"type":"string","description":"Custom text attribute 52."},"atr53":{"type":"string","description":"Custom text attribute 53."},"atr54":{"type":"string","description":"Custom text attribute 54."},"atr55":{"type":"string","description":"Custom text attribute 55."},"atr56":{"type":"string","description":"Custom text attribute 56."},"atr57":{"type":"string","description":"Custom text attribute 57."},"atr58":{"type":"string","description":"Custom text attribute 58."},"atr59":{"type":"string","description":"Custom text attribute 59."},"atr60":{"type":"string","description":"Custom text attribute 60."},"num1":{"type":"number","format":"double","description":"Custom number attribute 1."},"num2":{"type":"number","format":"double","description":"Custom number attribute 2."},"num3":{"type":"number","format":"double","description":"Custom number attribute 3."},"num4":{"type":"number","format":"double","description":"Custom number attribute 4."},"num5":{"type":"number","format":"double","description":"Custom number attribute 5."},"num6":{"type":"number","format":"double","description":"Custom number attribute 6."},"num7":{"type":"number","format":"double","description":"Custom number attribute 7."},"num8":{"type":"number","format":"double","description":"Custom number attribute 8."},"num9":{"type":"number","format":"double","description":"Custom number attribute 9."},"num10":{"type":"number","format":"double","description":"Custom number attribute 10."},"num11":{"type":"number","format":"double","description":"Custom number attribute 11."},"num12":{"type":"number","format":"double","description":"Custom number attribute 12."},"num13":{"type":"number","format":"double","description":"Custom number attribute 13."},"num14":{"type":"number","format":"double","description":"Custom number attribute 14."},"num15":{"type":"number","format":"double","description":"Custom number attribute 15."},"date1":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom date attribute 1 ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date"},"date2":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom date attribute 2 ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date"},"date3":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom date attribute 3 ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date"},"date4":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom date attribute 4 ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date"},"date5":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom date attribute 5 ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date"}}}},"components/schemas/EditPobItem":{"id":"components/schemas/EditPobItem","kind":"json-schema","title":"EditPobItem","data":{"type":"object","required":["id","name","pobTemplateId","pobVersion","expiryDate","leadLineId","comments"],"properties":{"id":{"type":"integer","format":"int64","description":"POB ID to edit."},"name":{"type":"string","description":"POB name."},"pobTemplateId":{"type":"integer","format":"int64","description":"POB template ID that defines the recognition rules."},"pobVersion":{"type":"integer","format":"int64","description":"Version of the POB template."},"expiryDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POB expiry date ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"2026-12-31"},"leadLineId":{"type":"integer","format":"int64","description":"Line that acts as the lead line of the POB."},"comments":{"type":"string","description":"Reason for the edit. Can be empty but must be present."}}}},"components/schemas/EditPobsRequest":{"id":"components/schemas/EditPobsRequest","kind":"json-schema","title":"EditPobsRequest","data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/EditPobItem"},"description":"POBs to edit."},"objectVersion":{"type":"integer","format":"int32","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/EditPobRequest":{"id":"components/schemas/EditPobRequest","kind":"json-schema","title":"EditPobRequest","data":{"type":"object","required":["name","pobTemplateId","pobVersion","expiryDate","leadLineId","comments"],"properties":{"name":{"type":"string","description":"POB name."},"pobTemplateId":{"type":"integer","format":"int64","description":"POB template ID that defines the recognition rules."},"pobVersion":{"type":"integer","format":"int64","description":"Version of the POB template."},"expiryDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POB expiry date ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":"2026-12-31"},"leadLineId":{"type":"integer","format":"int64","description":"Line that acts as the lead line of the POB."},"comments":{"type":"string","description":"Reason for the edit. Can be empty but must be present."},"objectVersion":{"type":"integer","format":"int32","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/CopyLineRequest":{"id":"components/schemas/CopyLineRequest","kind":"json-schema","title":"CopyLineRequest","data":{"type":"object","description":"Values you omit are copied from the source line.","required":["objectVersion","docLineId","pobName","pobTemplateId"],"properties":{"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract. Required for this action.","example":5},"docLineId":{"type":"string","description":"Source document line ID to copy."},"pobName":{"type":"string","description":"Name of the new manual POB."},"pobTemplateId":{"type":"integer","format":"int64","description":"POB template for the new POB."},"fvPrice":{"type":"number","format":"double","description":"Fair value price of the new line."},"itemNum":{"type":"string","description":"Item number."},"ordQty":{"type":"number","format":"double","description":"Ordered quantity."},"unitListPrc":{"type":"number","format":"double","description":"Unit list price."},"unitSellPrc":{"type":"number","format":"double","description":"Unit selling price."},"extLstPrc":{"type":"number","format":"double","description":"Extended list price."},"extSllPrc":{"type":"number","format":"double","description":"Extended selling price."},"docNum":{"type":"string","description":"Document number."},"docLineNum":{"type":"string","description":"Document line number."},"docDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document date ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"comments":{"type":"string","description":"Comment recorded in the audit history."}}}},"components/schemas/SwitchLeadLineRequest":{"id":"components/schemas/SwitchLeadLineRequest","kind":"json-schema","title":"SwitchLeadLineRequest","data":{"type":"object","required":["lineId","rcPobId"],"properties":{"lineId":{"type":"integer","format":"int64","description":"Line that becomes the lead line."},"rcPobId":{"type":"integer","format":"int64","description":"POB whose lead line changes."},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/MovePobRequest":{"id":"components/schemas/MovePobRequest","kind":"json-schema","title":"MovePobRequest","data":{"type":"object","required":["rcPobId","rcDerivedPobId","action","comments"],"properties":{"rcPobId":{"type":"integer","format":"int64","description":"POB to move."},"rcDerivedPobId":{"type":"integer","format":"int64","description":"Target derived POB."},"action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Move action. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MOVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"MOVE"},"comments":{"type":"string","description":"Reason for the move.","minLength":1},"lineId":{"type":"integer","format":"int64","description":"Move only this line of the POB. Omit to move the whole POB."},"derivedPobVal":{"type":"string","description":"Derived POB value.","default":""},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/CreateManualRcPob":{"id":"components/schemas/CreateManualRcPob","kind":"json-schema","title":"CreateManualRcPob","data":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64","description":"POB ID."},"retain":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keeps the POB in its source contract as well."},"children":[]}]}]}]}}}},"components/schemas/CreateManualRcRequest":{"id":"components/schemas/CreateManualRcRequest","kind":"json-schema","title":"CreateManualRcRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcPobIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"docLineIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not empty the contract is built at contract level."},"children":[]}]}]}],"properties":{"rcIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Whole contracts to group into the new contract."},"rcPobIds":{"type":"array","items":{"$ref":"#/components/schemas/CreateManualRcPob"},"description":"POBs to group into the new contract."},"docLineIds":{"type":"array","items":{"type":"string"},"description":"Document lines to group into the new contract."},"groupingTemplate":{"type":"integer","format":"int64","description":"Revenue contract grouping template ID."},"comments":{"type":"string","description":"Comment recorded in the audit history.","default":""},"secAtrVal":{"type":"string","description":"Organization (security attribute value) of the new contract, for multi-organization tenants.","default":""}}}},"components/schemas/LinkRcRequest":{"id":"components/schemas/LinkRcRequest","kind":"json-schema","title":"LinkRcRequest","data":{"type":"object","required":["targetRcIds"],"properties":{"targetRcIds":{"type":"array","minItems":1,"items":{"type":"integer","format":"int64"},"description":"Contracts to merge into the contract in the path."},"comments":{"type":"string","description":"Comment recorded in the contract's audit history.","default":""},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/LinkPobsRequest":{"id":"components/schemas/LinkPobsRequest","kind":"json-schema","title":"LinkPobsRequest","data":{"type":"object","required":["rcPobIds"],"properties":{"rcPobIds":{"type":"array","minItems":1,"items":{"type":"integer","format":"int64"},"description":"POBs to link into the contract."},"comments":{"type":"string","description":"Comment recorded in the contract's audit history.","default":""},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/LinkLinesRequest":{"id":"components/schemas/LinkLinesRequest","kind":"json-schema","title":"LinkLinesRequest","data":{"type":"object","required":["docLineIds"],"properties":{"docLineIds":{"type":"array","minItems":1,"items":{"type":"string"},"description":"Document line IDs to link."},"leadLineId":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Group the linked lines under this lead line. Takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcPobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"rcPobId":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attach the linked lines to this POB. Used only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"leadLineId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted."},"children":[]}]}]}]},"comments":{"type":"string","description":"Comment recorded in the contract's audit history.","default":""},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/LinkChargesRequest":{"id":"components/schemas/LinkChargesRequest","kind":"json-schema","title":"LinkChargesRequest","data":{"type":"object","required":["chargeNumbers"],"properties":{"chargeNumbers":{"type":"array","minItems":1,"items":{"type":"string"},"description":"Zuora Billing charge numbers to link."},"comments":{"type":"string","description":"Comment recorded in the contract's audit history.","default":""},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/LinkSubscriptionsRequest":{"id":"components/schemas/LinkSubscriptionsRequest","kind":"json-schema","title":"LinkSubscriptionsRequest","data":{"type":"object","required":["subscriptionIds"],"properties":{"subscriptionIds":{"type":"array","minItems":1,"items":{"type":"string"},"description":"Subscriptions to link."},"comments":{"type":"string","description":"Comment recorded in the contract's audit history.","default":""},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/DelinkRcRequest":{"id":"components/schemas/DelinkRcRequest","kind":"json-schema","title":"DelinkRcRequest","data":{"type":"object","properties":{"comments":{"type":"string","description":"Comment recorded in the contract's audit history.","default":""},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/DelinkPobsRequest":{"id":"components/schemas/DelinkPobsRequest","kind":"json-schema","title":"DelinkPobsRequest","data":{"type":"object","required":["rcPobIds"],"properties":{"rcPobIds":{"type":"array","minItems":1,"items":{"type":"integer","format":"int64"},"description":"POBs to remove from the contract."},"comments":{"type":"string","description":"Comment recorded in the contract's audit history.","default":""},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/DelinkLinesRequest":{"id":"components/schemas/DelinkLinesRequest","kind":"json-schema","title":"DelinkLinesRequest","data":{"type":"object","required":["docLineIds"],"properties":{"docLineIds":{"type":"array","minItems":1,"items":{"type":"string"},"description":"Document line IDs to remove from the contract."},"comments":{"type":"string","description":"Comment recorded in the contract's audit history.","default":""},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/DelinkChargesRequest":{"id":"components/schemas/DelinkChargesRequest","kind":"json-schema","title":"DelinkChargesRequest","data":{"type":"object","required":["chargeNumbers"],"properties":{"chargeNumbers":{"type":"array","minItems":1,"items":{"type":"string"},"description":"Zuora Billing charge numbers to remove."},"comments":{"type":"string","description":"Comment recorded in the contract's audit history.","default":""},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/DelinkSubscriptionsRequest":{"id":"components/schemas/DelinkSubscriptionsRequest","kind":"json-schema","title":"DelinkSubscriptionsRequest","data":{"type":"object","required":["subscriptionIds"],"properties":{"subscriptionIds":{"type":"array","minItems":1,"items":{"type":"string"},"description":"Subscriptions to remove."},"comments":{"type":"string","description":"Comment recorded in the contract's audit history.","default":""},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/UndoDelinkRequest":{"id":"components/schemas/UndoDelinkRequest","kind":"json-schema","title":"UndoDelinkRequest","data":{"type":"object","required":["objectVersion"],"properties":{"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract. Required.","example":5},"comments":{"type":"string","description":"Comment recorded in the audit history."}}}},"components/schemas/ApplyVcRequest":{"id":"components/schemas/ApplyVcRequest","kind":"json-schema","title":"ApplyVcRequest","data":{"type":"object","required":["rcLineId","vcTypeId","applyValue","applyType","vcRuleType"],"properties":{"rcLineId":{"type":"integer","format":"int64","description":"Revenue contract line to adjust."},"vcTypeId":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variable consideration type. List valid values with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /revenue-management/contracts/{rcId}/vc-types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"applyValue":{"type":"number","format":"double","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount or percentage to apply, depending on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"applyType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"applyValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an amount or a percentage. Case-sensitive. Ignored (treated as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vcRuleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", but still required."},"children":[]}]}]}],"enum":["AMOUNT","PERCENT"]},"vcRuleType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Variable consideration rule type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"E"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" estimate, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"A"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" actuals, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set. Case-sensitive."},"children":[]}]}]}],"enum":["E","A","S"]},"applyOn":{"type":"string","description":"Line amount or quantity field the variable consideration is based on.","default":""},"comments":{"type":"string","description":"Comment recorded in the audit history.","default":""},"calcMethod":{"type":"string","description":"Calculation method, for financing-type variable consideration.","default":""},"intFreq":{"type":"string","description":"Interest frequency, for financing-type variable consideration.","default":""},"intRate":{"type":"string","description":"Interest rate, for financing-type variable consideration.","default":""},"startDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Start date ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"default":""},"endDate":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"End date ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"default":""},"dryRun":{"type":"boolean","default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns a preview in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previewData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without saving the adjustment."},"children":[]}]}]}]},"objectVersion":{"type":"integer","format":"int32","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/ExpireVcRequest":{"id":"components/schemas/ExpireVcRequest","kind":"json-schema","title":"ExpireVcRequest","data":{"type":"object","required":["rcLinePriceAdjustmentId","amount"],"properties":{"rcLinePriceAdjustmentId":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Line price adjustment to expire ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcLineAdjustmentRecords[].id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from apply-vc)."},"children":[]}]}]}],"maximum":2147483647},"amount":{"type":"number","format":"double","description":"Amount to expire."},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/ImpairmentLine":{"id":"components/schemas/ImpairmentLine","kind":"json-schema","title":"ImpairmentLine","data":{"type":"object","required":["id","comments","impairmentType"],"properties":{"id":{"type":"integer","format":"int64","description":"Revenue contract line ID."},"comments":{"type":"string","description":"Reason for the impairment.","minLength":1},"impairmentType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Impairment type code: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contract impairment, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" new POB ratable, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" R and R within SSP, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" none."},"children":[]}]}]}],"example":"1"}}}},"components/schemas/ApplyImpairmentRequest":{"id":"components/schemas/ApplyImpairmentRequest","kind":"json-schema","title":"ApplyImpairmentRequest","data":{"type":"object","required":["lines"],"properties":{"lines":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/ImpairmentLine"}},"objectVersion":{"type":"integer","format":"int64","description":"Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.","example":5}}}},"components/schemas/EditUsageItem":{"id":"components/schemas/EditUsageItem","kind":"json-schema","title":"EditUsageItem","data":{"type":"object","description":"Only the fields you send are changed.","required":["id"],"properties":{"id":{"type":"integer","format":"int64","description":"Usage record ID.","minimum":1},"quantity":{"type":"number","format":"double","description":"New usage quantity."},"usageAmount":{"type":"number","format":"double","description":"New usage amount."},"unitPrice":{"type":"number","format":"double","description":"New unit price."},"atr1":{"type":"string","description":"Usage attribute 1."},"atr2":{"type":"string","description":"Usage attribute 2."},"atr3":{"type":"string","description":"Usage attribute 3."},"atr4":{"type":"string","description":"Usage attribute 4."},"atr5":{"type":"string","description":"Usage attribute 5."}}}},"components/schemas/EditUsageRequest":{"id":"components/schemas/EditUsageRequest","kind":"json-schema","title":"EditUsageRequest","data":{"type":"object","required":["items"],"properties":{"items":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/EditUsageItem"}}}}},"components/schemas/CancelUsageRequest":{"id":"components/schemas/CancelUsageRequest","kind":"json-schema","title":"CancelUsageRequest","data":{"type":"object","required":["usageId"],"properties":{"usageId":{"type":"integer","format":"int64","description":"Usage record ID to cancel.","minimum":1}}}},"components/schemas/VoidBillingRequest":{"id":"components/schemas/VoidBillingRequest","kind":"json-schema","title":"VoidBillingRequest","data":{"type":"object","required":["billDocNumber","reason"],"properties":{"billDocNumber":{"type":"string","description":"Billing document (invoice or credit memo) number to void.","minLength":1},"reason":{"type":"string","description":"Reason for voiding.","minLength":1},"comment":{"type":"string","description":"Additional comment.","default":""}}}},"components/schemas/PageMetadata":{"id":"components/schemas/PageMetadata","kind":"json-schema","title":"PageMetadata","data":{"type":"object","description":"Pagination details for a list response.","required":["number","size","totalElements","totalPages","first","last"],"properties":{"number":{"type":"integer","format":"int32","description":"Current page number (1-based)."},"size":{"type":"integer","format":"int32","description":"Page size applied."},"totalElements":{"type":"integer","format":"int64","description":"Total records matching the filters across all pages."},"totalPages":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total number of pages. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no record matches."},"children":[]}]}]}]},"first":{"type":"boolean","description":"True when this is the first page."},"last":{"type":"boolean","description":"True when this is the last page, or past the last page."}}}},"components/schemas/Indicators":{"id":"components/schemas/Indicators","kind":"json-schema","title":"Indicators","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status flags of the record. Each key is a flag name in camelCase and each value is a single-character code, usually "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Y"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"N"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The set of keys depends on the record type and the Zuora Revenue release."},"children":[]}]}]}],"additionalProperties":{"type":"string","minLength":1,"maxLength":1},"example":{"allocationEligible":"Y","multiCurrency":"N"}}},"components/schemas/RevenueContractHead":{"id":"components/schemas/RevenueContractHead","kind":"json-schema","title":"RevenueContractHead","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Header record of a revenue contract (RC). A revenue contract groups the sales order, billing, and contract lines that Zuora Revenue allocates and recognizes together under ASC 606 / IFRS 15. Amounts are returned as decimal strings. Dates without a time are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; timestamps are ISO 8601. The record carries additional contract attributes beyond the properties listed here (for example currencies, exchange rates, custom attributes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atr1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"-"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atr5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and audit fields); clients must tolerate additional properties."},"children":[]}]}]}],"required":["id","bookId"],"properties":{"id":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revenue contract ID. Use it as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in other calls."},"children":[]}]}]}]},"bookId":{"type":"integer","format":"int64","description":"Revenue book the contract belongs to."},"indicators":{"$ref":"#/components/schemas/Indicators"},"totalCarveAmount":{"type":"string","nullable":true,"description":"Total allocation (carve-in/carve-out) amount of the contract.","example":"1000.00"}},"additionalProperties":true}},"components/schemas/RevenueContractLine":{"id":"components/schemas/RevenueContractLine","kind":"json-schema","title":"RevenueContractLine","data":{"type":"object","description":"A transaction line (sales order, contract, or invoice line) grouped into a revenue contract. Custom attributes are returned in nested objects. Amounts are returned as decimal strings. The record carries additional line attributes beyond the properties listed here (for example prices, quantities, and dates); clients must tolerate additional properties. Calculated and account fields are not returned.","required":["id","rcId"],"properties":{"id":{"type":"integer","format":"int64","description":"Revenue contract line ID."},"rcId":{"type":"integer","format":"int64","description":"Revenue contract the line belongs to."},"indicators":{"$ref":"#/components/schemas/Indicators"},"stringAttributes":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom text attributes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atr1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"atr60"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"atr1":{"type":"string","nullable":true},"atr2":{"type":"string","nullable":true},"atr3":{"type":"string","nullable":true},"atr4":{"type":"string","nullable":true},"atr5":{"type":"string","nullable":true},"atr6":{"type":"string","nullable":true},"atr7":{"type":"string","nullable":true},"atr8":{"type":"string","nullable":true},"atr9":{"type":"string","nullable":true},"atr10":{"type":"string","nullable":true},"atr11":{"type":"string","nullable":true},"atr12":{"type":"string","nullable":true},"atr13":{"type":"string","nullable":true},"atr14":{"type":"string","nullable":true},"atr15":{"type":"string","nullable":true},"atr16":{"type":"string","nullable":true},"atr17":{"type":"string","nullable":true},"atr18":{"type":"string","nullable":true},"atr19":{"type":"string","nullable":true},"atr20":{"type":"string","nullable":true},"atr21":{"type":"string","nullable":true},"atr22":{"type":"string","nullable":true},"atr23":{"type":"string","nullable":true},"atr24":{"type":"string","nullable":true},"atr25":{"type":"string","nullable":true},"atr26":{"type":"string","nullable":true},"atr27":{"type":"string","nullable":true},"atr28":{"type":"string","nullable":true},"atr29":{"type":"string","nullable":true},"atr30":{"type":"string","nullable":true},"atr31":{"type":"string","nullable":true},"atr32":{"type":"string","nullable":true},"atr33":{"type":"string","nullable":true},"atr34":{"type":"string","nullable":true},"atr35":{"type":"string","nullable":true},"atr36":{"type":"string","nullable":true},"atr37":{"type":"string","nullable":true},"atr38":{"type":"string","nullable":true},"atr39":{"type":"string","nullable":true},"atr40":{"type":"string","nullable":true},"atr41":{"type":"string","nullable":true},"atr42":{"type":"string","nullable":true},"atr43":{"type":"string","nullable":true},"atr44":{"type":"string","nullable":true},"atr45":{"type":"string","nullable":true},"atr46":{"type":"string","nullable":true},"atr47":{"type":"string","nullable":true},"atr48":{"type":"string","nullable":true},"atr49":{"type":"string","nullable":true},"atr50":{"type":"string","nullable":true},"atr51":{"type":"string","nullable":true},"atr52":{"type":"string","nullable":true},"atr53":{"type":"string","nullable":true},"atr54":{"type":"string","nullable":true},"atr55":{"type":"string","nullable":true},"atr56":{"type":"string","nullable":true},"atr57":{"type":"string","nullable":true},"atr58":{"type":"string","nullable":true},"atr59":{"type":"string","nullable":true},"atr60":{"type":"string","nullable":true}}},"numberAttributes":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom number attributes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"num1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"num15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"num1":{"type":"string","nullable":true,"description":"Decimal value serialized as a string."},"num2":{"type":"string","nullable":true,"description":"Decimal value serialized as a string."},"num3":{"type":"string","nullable":true,"description":"Decimal value serialized as a string."},"num4":{"type":"string","nullable":true,"description":"Decimal value serialized as a string."},"num5":{"type":"string","nullable":true,"description":"Decimal value serialized as a string."},"num6":{"type":"string","nullable":true,"description":"Decimal value serialized as a string."},"num7":{"type":"string","nullable":true,"description":"Decimal value serialized as a string."},"num8":{"type":"string","nullable":true,"description":"Decimal value serialized as a string."},"num9":{"type":"string","nullable":true,"description":"Decimal value serialized as a string."},"num10":{"type":"string","nullable":true,"description":"Decimal value serialized as a string."},"num11":{"type":"string","nullable":true,"description":"Decimal value serialized as a string."},"num12":{"type":"string","nullable":true,"description":"Decimal value serialized as a string."},"num13":{"type":"string","nullable":true,"description":"Decimal value serialized as a string."},"num14":{"type":"string","nullable":true,"description":"Decimal value serialized as a string."},"num15":{"type":"string","nullable":true,"description":"Decimal value serialized as a string."}}},"dateAttributes":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom date attributes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"date1":{"type":"string","format":"date","nullable":true},"date2":{"type":"string","format":"date","nullable":true},"date3":{"type":"string","format":"date","nullable":true},"date4":{"type":"string","format":"date","nullable":true},"date5":{"type":"string","format":"date","nullable":true}}},"rcLineOtrAttributes":{"type":"object","description":"Other line attributes.","additionalProperties":true,"properties":{"rpcNum":{"type":"string","nullable":true,"description":"Zuora Billing rate plan charge number of the line."}}}},"additionalProperties":true}},"components/schemas/RevenueHoldFlags":{"id":"components/schemas/RevenueHoldFlags","kind":"json-schema","title":"RevenueHoldFlags","data":{"type":"object","description":"Configuration flags of a revenue hold definition.","properties":{"enabled":{"type":"string","enum":["Y","N"],"description":"Whether the hold is active."},"allowManualRelease":{"type":"string","enum":["Y","N"],"description":"Whether users and APIs can release the hold manually."},"allowManualApply":{"type":"string","enum":["Y","N"],"description":"Whether users and APIs can apply the hold manually."},"holdType":{"type":"string","enum":["Revenue Hold","Transfer Hold"],"description":"Hold type. Omitted when not configured."},"holdLevel":{"type":"string","enum":["RC","POB","LINE","CHARGE"],"description":"Level the hold applies to. Omitted when not configured."},"scheduleType":{"type":"string","enum":["Revenue","Allocation","Both","None"],"description":"Schedules blocked by the hold."}}}},"components/schemas/RevenueHold":{"id":"components/schemas/RevenueHold","kind":"json-schema","title":"RevenueHold","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A revenue hold definition configured in Zuora Revenue setup. Apply and release these holds with the Manual Action APIs by passing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"id":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hold definition ID ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"holdId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"name":{"type":"string","description":"Hold name."},"description":{"type":"string","nullable":true,"description":"Hold description."},"startDate":{"type":"string","nullable":true,"description":"Date the hold definition becomes effective."},"endDate":{"type":"string","nullable":true,"description":"Date the hold definition stops being effective."},"eventId":{"type":"integer","format":"int64","nullable":true,"description":"Release event linked to the hold."},"expiryFieldName":{"type":"string","nullable":true,"description":"Field used to calculate automatic expiry of the hold."},"expiryNumberType":{"type":"string","nullable":true,"description":"Unit of the expiry duration, such as days or months."},"expiryDuration":{"type":"integer","format":"int64","nullable":true,"description":"Number of expiry units after which the hold expires."},"flags":{"$ref":"#/components/schemas/RevenueHoldFlags"},"createdPeriodId":{"type":"integer","format":"int64","description":"Period in which the hold was created."},"clientId":{"type":"integer","format":"int64","description":"Zuora Revenue client ID."},"createdBy":{"type":"string","description":"User who created the hold."},"createdDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creation date ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"updatedBy":{"type":"string","description":"User who last updated the hold."},"updatedDate":{"type":"string","format":"date","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last update date ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}},"additionalProperties":true}},"components/schemas/RevenueContractHeadPage":{"id":"components/schemas/RevenueContractHeadPage","kind":"json-schema","title":"RevenueContractHeadPage","data":{"type":"object","required":["data","page"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RevenueContractHead"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}}},"components/schemas/RevenueContractLinePage":{"id":"components/schemas/RevenueContractLinePage","kind":"json-schema","title":"RevenueContractLinePage","data":{"type":"object","required":["data","page"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RevenueContractLine"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}}},"components/schemas/RevenueHoldPage":{"id":"components/schemas/RevenueHoldPage","kind":"json-schema","title":"RevenueHoldPage","data":{"type":"object","required":["data","page"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RevenueHold"}},"page":{"$ref":"#/components/schemas/PageMetadata"}}}},"components/schemas/ContractQueryErrorResponse":{"id":"components/schemas/ContractQueryErrorResponse","kind":"json-schema","title":"ContractQueryErrorResponse","data":{"type":"object","required":["error"],"description":"Error returned by the Revenue Contract Management APIs.","properties":{"error":{"type":"string","description":"Human-readable error message."}}}},"components/schemas/ReportingRiaError":{"id":"components/schemas/ReportingRiaError","kind":"json-schema","title":"ReportingRiaError","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error envelope used by the Revenue Integration Reporting APIs. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is usually "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the detail."},"children":[]}]}]}],"properties":{"Status":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for most failures. On a few errors (for example a signing-service failure on Get a signed URL) the error text itself is returned here."},"children":[]}]}]}],"example":"Error"},"Message":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable error detail. A string on most errors; an object such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"Invalid_fields\": [...]}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on field validation errors."},"children":[]}]}]}],"example":"Invalid date format 2026-09-22 for createddate"},"Result":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional error detail, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"schema_0":{"kind":"json-schema","data":{"type":"string","default":"API Role"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","default":"Default"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"object","properties":{"Message":{"type":"string","description":"Token","default":"Token Generated"},"status":{"type":"string","description":"Response Status","default":"success"}}},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"string"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"object","properties":{"Dateformat":{"type":"string","description":"Response Status","default":"DD-MON-YYYY"},"Mapping":{"type":"array","items":{"$ref":"#/components/schemas/uploadMapping"}}}},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"object","properties":{"Result":{"type":"array","items":{"$ref":"#/components/schemas/uploadStatus"}},"message":{"type":"string","description":"Response Message","default":"Data Staged Successfully"},"status":{"type":"string","description":"Response Status","default":"Success"}}},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"string","enum":["multipart/form-data"]},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"The path to the CSV file that is to be uploaded.","format":"binary"}}},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":"Response Message","default":"File received successfully"},"status":{"type":"string","description":"Response Status","default":"Success"}}},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":"Response Message","default":"Exception occurred. Please contact Zuora Revenue Support"},"status":{"type":"string","description":"Response Status","default":"Error"}}},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"object","properties":{"client_id":{"type":"integer"},"id":{"type":"integer"},"message":{"type":"string","default":"Data Received"},"status":{"type":"string","default":"Successfully Uploaded"}}},"status":{"type":"string","description":"Response Response","default":"Success"}}},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"object","properties":{"Result":{"type":"string"},"message":{"type":"string","description":"Default error message","default":"No data found"},"status":{"type":"string","description":"Error Response","default":"Error"}}},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","description":"The actual data to be uploaded."}},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":"Response Message","default":"Data Staged Successfully"},"result":{"type":"object","properties":{"client_id":{"type":"integer"},"id":{"type":"integer"},"message":{"type":"string"},"status":{"type":"string"}}},"status":{"type":"string","description":"Response Status","default":"Success"}}},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"object","properties":{"message":{"type":"string","description":"Error Message","default":"Error loading Data into Staging Area"},"result":{"type":"object","properties":{"client_id":{"type":"integer"},"id":{"type":"integer"},"message":{"type":"string"},"status":{"type":"string"}}},"status":{"type":"string","description":"Error Response","default":"Error"}}},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"string","enum":["transaction","event"]},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"object","properties":{"Result":{"type":"array","items":{"$ref":"#/components/schemas/stageError"}},"status":{"type":"string","description":"Response Status","default":"Success"}}},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","description":"Response Status","default":"Success"}}},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"object","properties":{"status":{"type":"string","description":"Response Status","default":"Error"},"message":{"type":"string","description":"0 row(s) updated. Only the batch in Ready TO Transfer status can be updated."}}},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"type":"array","items":{"$ref":"#/components/schemas/Journal"}},"status":{"type":"string","description":"Response Status","default":"Success"}}},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"object","properties":{"active":{"type":"array","description":"Response Status"}}},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"integer","default":0,"format":"int32","minimum":0},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"integer","default":20,"format":"int32","minimum":1},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Report"}},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ServiceError"},{"$ref":"#/components/schemas/SpringError"}]},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"object","properties":{"Retry-After":{"type":"string","description":"Seconds to wait before retrying."}}},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"anyOf":[{"anyOf":[{"$ref":"#/components/schemas/MissingFiltersError"},{"$ref":"#/components/schemas/SimpleError"},{"$ref":"#/components/schemas/ServiceError"}]},{"$ref":"#/components/schemas/SpringError"}]},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/SimpleError"},{"$ref":"#/components/schemas/ServiceError"}]},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/SimpleError"},{"$ref":"#/components/schemas/SpringError"}]},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/GatewayError"},{"$ref":"#/components/schemas/ReportingRiaError"}]},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"integer","default":1000},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"string","default":"gzip","enum":["gzip","csv"]},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"object","properties":{"continuation-token":{"type":"string","description":"Task identifier to send when requesting later pages."}}},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/GatewayError"},{"$ref":"#/components/schemas/RiaError"}]},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"object","properties":{"continuation-token":{"type":"string","description":"Task identifier of the interrupted task."}}},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/BiViewFieldsRequest"},{"type":"array","items":{"type":"string"}}]},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/BiViewColumn"}},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/RiaError"},{"$ref":"#/components/schemas/BiViewReportSubmitResponse"}]},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"string","enum":["csv"]},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/BiViewCountV1"},{"$ref":"#/components/schemas/RiaError"}]},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request. Quote it when you contact Zuora Support."}}},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":20},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/JournalEntryResponse"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Projected header (when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supplied): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus the requested properties."},"children":[]}]}]}],"additionalProperties":true}]},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/JournalEntryListItem"}},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/JournalEntryResponse"},{"$ref":"#/components/schemas/JournalEntryLinesPage"}]},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/JournalEntryLineDataset"}},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/JournalEntryLine"}},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AuditEvent"}},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SummaryValue"}},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SoftFreeze"}},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"string","enum":["jeHead","jeLine","rcSchedule"]},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"string","enum":["RC","SO","LINE"]},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"type":"object","properties":{"traceId":{"type":"string","description":"Identifier of the request. Quote it when you contact Zuora Support."},"Content-Disposition":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attachment file name, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment; filename=\"je-list.csv\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":0,"default":1},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":20},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"type":"integer","format":"int64","default":1},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"string","maxLength":64},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"type":"object","properties":{"traceId":{"type":"string","description":"Correlation ID of the request. Quote it when you contact Zuora Global Support."}}},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"type":"string","enum":["RC","POB","LINE","CHARGE"],"default":"RC"},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"string","enum":["open","close"]},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"type":"string","enum":["E","A","S"]},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/VcType"}},"id":"schema_69"}},"exampleStore":{"components/examples/Tenant":{"id":"components/examples/Tenant","value":{"timestamp":"2026-10-09T07:15:02.123+00:00","status":400,"error":"Bad Request"},"summary":"Tenant could not be resolved","description":"Returned before the operation runs when the Zuora tenant of the token is not provisioned for Zuora Revenue, or the Revenue database connection could not be set up. Confirm the tenant has Zuora Revenue enabled; if it has, retry later and contact Zuora Support."},"components/examples/Unauthorized":{"id":"components/examples/Unauthorized","value":{"message":"Authentication error"},"summary":"Expired or missing token"},"components/examples/Forbidden":{"id":"components/examples/Forbidden","value":{"message":"Failed to get user info."},"summary":"Client not entitled"},"components/examples/RateLimited":{"id":"components/examples/RateLimited","value":{"message":"Too many requests"},"summary":"Rate limit exceeded"},"components/examples/ServerError":{"id":"components/examples/ServerError","value":{"message":"An error occurred: Unexpected internal error","code":"1"},"summary":"Unexpected error"},"components/examples/NoUser":{"id":"components/examples/NoUser","value":{"Status":"Error","Result":null,"Message":"Zuora-Global-User-Id header is required for OAuth authentication"},"summary":"OAuth client not linked to a Zuora user","description":"The OAuth client must be created by, or mapped to, a Zuora user that has a Zuora Revenue role."},"components/examples/DbConnect":{"id":"components/examples/DbConnect","value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"summary":"Database connection failed","description":"Temporary. Retry with backoff."},"components/examples/NoRevenueUser":{"id":"components/examples/NoRevenueUser","value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue."},"components/examples/Restricted":{"id":"components/examples/Restricted","value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"summary":"API not enabled for the tenant"},"components/examples/CustomHeaders":{"id":"components/examples/CustomHeaders","value":{"Status":"Error","Result":null,"Message":"Missing/Invalid request headers"},"summary":"Required custom headers missing"},"components/examples/NotFound":{"id":"components/examples/NotFound","value":{"Status":"Error","Message":"No data found matching the criteria"},"summary":"No data"},"components/examples/DbError":{"id":"components/examples/DbError","value":{"Status":"Error","Result":null,"Message":"Unexpected Error. Please contact Zuora Revenue Support"},"summary":"Database error"},"components/examples/QueryService":{"id":"components/examples/QueryService","value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"summary":"Query service error"},"components/examples/MissingParam":{"id":"components/examples/MissingParam","value":{"Status":"Error","Message":"Mandatory field fromDate is missing in path"},"summary":"fromDate missing"},"components/examples/BadDate":{"id":"components/examples/BadDate","value":{"Status":"Error","Message":"Invalid date format 2026-09-01 for fromDate"},"summary":"Wrong date format"},"components/examples/BadView":{"id":"components/examples/BadView","value":{"Status":"Error","Message":"('BI3_RC_LINES', {'BI3_ACCT_TYPE': 'RPRO_BI3_ACCT_TYPE_V', '...': '...'}, None)"},"summary":"Unknown BI View name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The message lists the requested name and the views supported for the tenant. Correct the name using the list in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tmpl_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" description."},"children":[]}]}]}]},"components/examples/MjeUnauthorized":{"id":"components/examples/MjeUnauthorized","value":{"message":"Authentication error"},"summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}]},"components/examples/MjeApisNotEnabled":{"id":"components/examples/MjeApisNotEnabled","value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it."},"components/examples/RoleLacksReadAccess":{"id":"components/examples/RoleLacksReadAccess","value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}]},"components/examples/TooManyRequests":{"id":"components/examples/TooManyRequests","value":{"message":"Too many requests"},"summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}]},"components/examples/UnexpectedError":{"id":"components/examples/UnexpectedError","value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}]},"components/examples/ServiceUnavailable":{"id":"components/examples/ServiceUnavailable","value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff."},"components/examples/RoleLacksEditAccess":{"id":"components/examples/RoleLacksEditAccess","value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}]},"components/examples/ContractNotFound":{"id":"components/examples/ContractNotFound","value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it."},"components/examples/ObjectVersionUnresolved":{"id":"components/examples/ObjectVersionUnresolved","value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}]},"components/examples/MalformedBody":{"id":"components/examples/MalformedBody","value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field)."},"components/examples/InvalidBookHeader":{"id":"components/examples/InvalidBookHeader","value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}]},"components/examples/SystemError":{"id":"components/examples/SystemError","value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"summary":"Internal server error"},"components/examples/EngineRejected":{"id":"components/examples/EngineRejected","value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"components/examples/EngineNotFound":{"id":"components/examples/EngineNotFound","value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"summary":"Object not found by the revenue engine"},"components/examples/EngineConflict":{"id":"components/examples/EngineConflict","value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}]},"components/examples/EnginePermissionDenied":{"id":"components/examples/EnginePermissionDenied","value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"summary":"Not permitted"},"components/examples/EngineResourceExhausted":{"id":"components/examples/EngineResourceExhausted","value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"summary":"Engine capacity exceeded"},"components/examples/EngineUnavailable":{"id":"components/examples/EngineUnavailable","value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"summary":"Revenue engine unavailable"},"components/examples/EngineTimeout":{"id":"components/examples/EngineTimeout","value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"summary":"Revenue engine timeout"},"paths/~1revenue~1services~1v1~1reports/get/responses/200/content/application~1json/examples/byCategory":{"value":[{"id":10021,"name":"Revenue Waterfall Report","description":"Recognized and scheduled revenue by period for each revenue contract line","category":"Revenue","sequence":3,"createdBy":"SYSADMIN","createdAt":"2024-01-15T09:30:00","updatedBy":"FIN.ADMIN","updatedAt":"2026-08-02T14:05:11"},{"id":10034,"name":"Deferred Revenue Roll Forward","description":"Opening balance, additions, recognition and closing deferred revenue by period","category":"Revenue","sequence":5,"createdBy":"SYSADMIN","createdAt":"2024-01-15T09:30:00","updatedBy":"SYSADMIN","updatedAt":"2025-11-20T08:00:00"}],"key":"byCategory","summary":"Reports in the Revenue category","id":"paths/~1revenue~1services~1v1~1reports/get/responses/200/content/application~1json/examples/byCategory"},"paths/~1revenue~1services~1v1~1reports/get/responses/200/content/application~1json/examples/empty":{"value":[],"key":"empty","summary":"No report matches the filters","id":"paths/~1revenue~1services~1v1~1reports/get/responses/200/content/application~1json/examples/empty"},"paths/~1revenue~1services~1v1~1reports/get/responses/400/content/application~1json/examples/badPage":{"value":{"message":"An error occurred: Invalid pagination parameters: page=-1, size=20","code":"1"},"key":"badPage","summary":"Invalid pagination","id":"paths/~1revenue~1services~1v1~1reports/get/responses/400/content/application~1json/examples/badPage"},"paths/~1revenue~1services~1v1~1reports/get/responses/400/content/application~1json/examples/tenant":{"value":{"timestamp":"2026-10-09T07:15:02.123+00:00","status":400,"error":"Bad Request"},"key":"tenant","summary":"Tenant could not be resolved","description":"Returned before the operation runs when the Zuora tenant of the token is not provisioned for Zuora Revenue, or the Revenue database connection could not be set up. Confirm the tenant has Zuora Revenue enabled; if it has, retry later and contact Zuora Support.","id":"paths/~1revenue~1services~1v1~1reports/get/responses/400/content/application~1json/examples/tenant"},"paths/~1revenue~1services~1v1~1reports/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1revenue~1services~1v1~1reports/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1revenue~1services~1v1~1reports/get/responses/403/content/application~1json/examples/forbidden":{"value":{"message":"Failed to get user info."},"key":"forbidden","summary":"Client not entitled","id":"paths/~1revenue~1services~1v1~1reports/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1revenue~1services~1v1~1reports/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1revenue~1services~1v1~1reports/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1revenue~1services~1v1~1reports/get/responses/500/content/application~1json/examples/typeMismatch":{"value":{"message":"An error occurred: Method parameter 'page': Failed to convert value of type 'java.lang.String' to required type 'int'; For input string: \"abc\"","code":"1"},"key":"typeMismatch","summary":"Non-numeric page","id":"paths/~1revenue~1services~1v1~1reports/get/responses/500/content/application~1json/examples/typeMismatch"},"paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/200/content/application~1json/examples/found":{"value":{"id":10021,"name":"Revenue Waterfall Report","description":"Recognized and scheduled revenue by period for each revenue contract line","category":"Revenue","sequence":3,"createdBy":"SYSADMIN","createdAt":"2024-01-15T09:30:00","updatedBy":"FIN.ADMIN","updatedAt":"2026-08-02T14:05:11"},"key":"found","summary":"Report found","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/200/content/application~1json/examples/found"},"paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/400/content/application~1json/examples/tenant":{"value":{"timestamp":"2026-10-09T07:15:02.123+00:00","status":400,"error":"Bad Request"},"key":"tenant","summary":"Tenant could not be resolved","description":"Returned before the operation runs when the Zuora tenant of the token is not provisioned for Zuora Revenue, or the Revenue database connection could not be set up. Confirm the tenant has Zuora Revenue enabled; if it has, retry later and contact Zuora Support.","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/400/content/application~1json/examples/tenant"},"paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/403/content/application~1json/examples/forbidden":{"value":{"message":"Failed to get user info."},"key":"forbidden","summary":"Client not entitled","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/500/content/application~1json/examples/serverError":{"value":{"message":"An error occurred: Unexpected internal error","code":"1"},"key":"serverError","summary":"Unexpected error","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}/get/responses/500/content/application~1json/examples/serverError"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/200/content/application~1json/examples/layouts":{"value":{"layouts":[{"id":3105,"reportId":10021,"name":"Monthly Close - Summary","description":"Summary by period for month-end close","filenamePrefix":"WF_SUMMARY","createdBy":"FIN.ADMIN","createdAt":"2025-03-01T10:00:00","updatedBy":"FIN.ADMIN","updatedAt":"2026-07-30T16:12:45","fields":[{"id":55012,"layoutId":3105,"fieldId":8801,"seq":1,"sortSeq":1,"fieldName":"periodName","fieldLabel":"Period Name","fieldType":"VARCHAR2"},{"id":55013,"layoutId":3105,"fieldId":8802,"seq":2,"sortSeq":null,"fieldName":"rcId","fieldLabel":"Revenue Contract ID","fieldType":"NUMBER"},{"id":55014,"layoutId":3105,"fieldId":8810,"seq":3,"sortSeq":null,"fieldName":"recognizedAmount","fieldLabel":"Recognized Amount","fieldType":"NUMBER"}],"filters":[{"id":70033,"layoutId":3105,"fieldId":8801,"fieldName":"periodName","fieldLabel":"Period Name","fieldType":"VARCHAR2","type":"LOV","valueFrom":"$revpro.CurrPrd","valueTo":null,"createdBy":"SYSADMIN","createdAt":"2025-03-01T10:00:00","updatedBy":"SYSADMIN","updatedAt":"2025-03-01T10:00:00","required":true,"options":[{"label":"AUG-2026","value":"AUG-2026"},{"label":"SEP-2026","value":"SEP-2026"}]},{"id":70034,"layoutId":3105,"fieldId":8820,"fieldName":"wfType","fieldLabel":"Waterfall Type","fieldType":"VARCHAR2","type":"LOV","valueFrom":"R","valueTo":null,"createdBy":"SYSADMIN","createdAt":"2025-03-01T10:00:00","updatedBy":"SYSADMIN","updatedAt":"2025-03-01T10:00:00","required":null,"options":[{"label":"Revenue","value":"R"},{"label":"Cost","value":"C"}]}]}],"totalCount":1},"key":"layouts","summary":"One layout with fields and filters","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/200/content/application~1json/examples/layouts"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/200/content/application~1json/examples/none":{"value":{"layouts":[],"totalCount":0},"key":"none","summary":"Report has no layouts, or the report does not exist","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/200/content/application~1json/examples/none"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/400/content/application~1json/examples/tenant":{"value":{"timestamp":"2026-10-09T07:15:02.123+00:00","status":400,"error":"Bad Request"},"key":"tenant","summary":"Tenant could not be resolved","description":"Returned before the operation runs when the Zuora tenant of the token is not provisioned for Zuora Revenue, or the Revenue database connection could not be set up. Confirm the tenant has Zuora Revenue enabled; if it has, retry later and contact Zuora Support.","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/400/content/application~1json/examples/tenant"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/403/content/application~1json/examples/forbidden":{"value":{"message":"Failed to get user info."},"key":"forbidden","summary":"Client not entitled","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/500/content/application~1json/examples/serverError":{"value":{"message":"An error occurred: Unexpected internal error","code":"1"},"key":"serverError","summary":"Unexpected error","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts/get/responses/500/content/application~1json/examples/serverError"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/200/content/application~1json/examples/found":{"value":{"id":3105,"reportId":10021,"name":"Monthly Close - Summary","description":"Summary by period for month-end close","filenamePrefix":"WF_SUMMARY","createdBy":"FIN.ADMIN","createdAt":"2025-03-01T10:00:00","updatedBy":"FIN.ADMIN","updatedAt":"2026-07-30T16:12:45","fields":[{"id":55012,"layoutId":3105,"fieldId":8801,"seq":1,"sortSeq":1,"fieldName":"periodName","fieldLabel":"Period Name","fieldType":"VARCHAR2"},{"id":55013,"layoutId":3105,"fieldId":8802,"seq":2,"sortSeq":null,"fieldName":"rcId","fieldLabel":"Revenue Contract ID","fieldType":"NUMBER"},{"id":55014,"layoutId":3105,"fieldId":8810,"seq":3,"sortSeq":null,"fieldName":"recognizedAmount","fieldLabel":"Recognized Amount","fieldType":"NUMBER"}],"filters":[{"id":70033,"layoutId":3105,"fieldId":8801,"fieldName":"periodName","fieldLabel":"Period Name","fieldType":"VARCHAR2","type":"LOV","valueFrom":"$revpro.CurrPrd","valueTo":null,"createdBy":"SYSADMIN","createdAt":"2025-03-01T10:00:00","updatedBy":"SYSADMIN","updatedAt":"2025-03-01T10:00:00","required":true,"options":[{"label":"AUG-2026","value":"AUG-2026"},{"label":"SEP-2026","value":"SEP-2026"}]},{"id":70034,"layoutId":3105,"fieldId":8820,"fieldName":"wfType","fieldLabel":"Waterfall Type","fieldType":"VARCHAR2","type":"LOV","valueFrom":"R","valueTo":null,"createdBy":"SYSADMIN","createdAt":"2025-03-01T10:00:00","updatedBy":"SYSADMIN","updatedAt":"2025-03-01T10:00:00","required":null,"options":[{"label":"Revenue","value":"R"},{"label":"Cost","value":"C"}]}]},"key":"found","summary":"Layout with fields and filters","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/200/content/application~1json/examples/found"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/400/content/application~1json/examples/tenant":{"value":{"timestamp":"2026-10-09T07:15:02.123+00:00","status":400,"error":"Bad Request"},"key":"tenant","summary":"Tenant could not be resolved","description":"Returned before the operation runs when the Zuora tenant of the token is not provisioned for Zuora Revenue, or the Revenue database connection could not be set up. Confirm the tenant has Zuora Revenue enabled; if it has, retry later and contact Zuora Support.","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/400/content/application~1json/examples/tenant"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/403/content/application~1json/examples/forbidden":{"value":{"message":"Failed to get user info."},"key":"forbidden","summary":"Client not entitled","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/500/content/application~1json/examples/serverError":{"value":{"message":"An error occurred: Unexpected internal error","code":"1"},"key":"serverError","summary":"Unexpected error","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}/get/responses/500/content/application~1json/examples/serverError"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/200/content/application~1json/examples/fields":{"value":{"layoutFields":[{"id":55012,"layoutId":3105,"fieldId":8801,"seq":1,"sortSeq":1,"fieldName":"periodName","fieldLabel":"Period Name","fieldType":"VARCHAR2"},{"id":55013,"layoutId":3105,"fieldId":8802,"seq":2,"sortSeq":null,"fieldName":"rcId","fieldLabel":"Revenue Contract ID","fieldType":"NUMBER"},{"id":55014,"layoutId":3105,"fieldId":8810,"seq":3,"sortSeq":null,"fieldName":"recognizedAmount","fieldLabel":"Recognized Amount","fieldType":"NUMBER"}]},"key":"fields","summary":"Three columns","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/200/content/application~1json/examples/fields"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/400/content/application~1json/examples/tenant":{"value":{"timestamp":"2026-10-09T07:15:02.123+00:00","status":400,"error":"Bad Request"},"key":"tenant","summary":"Tenant could not be resolved","description":"Returned before the operation runs when the Zuora tenant of the token is not provisioned for Zuora Revenue, or the Revenue database connection could not be set up. Confirm the tenant has Zuora Revenue enabled; if it has, retry later and contact Zuora Support.","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/400/content/application~1json/examples/tenant"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/403/content/application~1json/examples/forbidden":{"value":{"message":"Failed to get user info."},"key":"forbidden","summary":"Client not entitled","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/500/content/application~1json/examples/serverError":{"value":{"message":"An error occurred: Unexpected internal error","code":"1"},"key":"serverError","summary":"Unexpected error","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1layouts~1{layoutId}~1fields/get/responses/500/content/application~1json/examples/serverError"},"paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/200/content/application~1json/examples/byName":{"value":{"reportId":10021,"reportName":"Revenue Waterfall Report","reportType":"STANDARD","metadata":{"description":"Recognized and scheduled revenue by period for each revenue contract line","parameters":[],"filters":[],"columns":[{"id":8801,"fieldName":"PERIOD_NAME","alias":"PERIOD_NAME","fieldType":"VARCHAR2","label":"Period Name"},{"id":8802,"fieldName":"RC_ID","alias":"RC_ID","fieldType":"NUMBER","label":"Revenue Contract ID"}]},"layouts":[{"layoutId":3105,"layoutName":"Monthly Close - Summary","isDefault":true},{"layoutId":3106,"layoutName":"Auditor Extract","isDefault":false}]},"key":"byName","summary":"Metadata resolved by name","id":"paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/200/content/application~1json/examples/byName"},"paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/400/content/application~1json/examples/tenant":{"value":{"timestamp":"2026-10-09T07:15:02.123+00:00","status":400,"error":"Bad Request"},"key":"tenant","summary":"Tenant could not be resolved","description":"Returned before the operation runs when the Zuora tenant of the token is not provisioned for Zuora Revenue, or the Revenue database connection could not be set up. Confirm the tenant has Zuora Revenue enabled; if it has, retry later and contact Zuora Support.","id":"paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/400/content/application~1json/examples/tenant"},"paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/403/content/application~1json/examples/forbidden":{"value":{"message":"Failed to get user info."},"key":"forbidden","summary":"Client not entitled","id":"paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/500/content/application~1json/examples/serverError":{"value":{"message":"An error occurred: Unexpected internal error","code":"1"},"key":"serverError","summary":"Unexpected error","id":"paths/~1revenue~1services~1v1~1reports~1{reportIdentifier}~1metadata/get/responses/500/content/application~1json/examples/serverError"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/defaults":{"value":{"layoutId":3105},"key":"defaults","summary":"Run with the layout's saved filters","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/defaults"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/override":{"value":{"layoutId":3105,"filters":[{"fieldName":"periodName","operator":"=","value":"SEP-2026"}]},"key":"override","summary":"Override the period, keep other defaults","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/override"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/dateRange":{"value":{"layoutId":3105,"filters":[{"fieldName":"glDate","operator":"BETWEEN","value":"2026-09-01","valueTo":"2026-09-30"},{"fieldName":"rcId","operator":"IN","value":"120045,120046,120051"}]},"key":"dateRange","summary":"Date range and list filters","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/dateRange"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/macro":{"value":{"layoutId":3105,"filters":[{"fieldName":"periodName","value":"$revpro.CurrPrd"}]},"key":"macro","summary":"Current open period macro","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/requestBody/content/application~1json/examples/macro"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/200/content/application~1json/examples/accepted":{"value":{"id":482391,"reportId":10021,"layoutId":3105,"status":"Submitted","fileName":null,"filterParameters":"{\"filters\":[{\"key\":\"A300\",\"val1\":\"SEP-2026\"},{\"key\":\"A101\",\"val1\":\"R\"}]}","config":"{\"Show Filters\":\"Y\",\"Enable Totals\":\"N\"}","createdBy":"INTEGRATION.USER","runDate":"2026-10-09T07:15:02","updatedBy":"INTEGRATION.USER","updatedAt":"2026-10-09T07:15:02"},"key":"accepted","summary":"Run accepted","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/200/content/application~1json/examples/accepted"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/missingLayout":{"value":{"message":"Validation failed :layoutId is required","code":"1"},"key":"missingLayout","summary":"layoutId missing","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/missingLayout"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/missingFilters":{"value":{"error":"Missing required filters","missingFilters":["Period Name"]},"key":"missingFilters","summary":"Required filter missing","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/missingFilters"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodMultiple":{"value":{"error":"Could not resolve $revpro.CurrPrd: multiple open periods were found; specify a concrete period name.","errorCode":"INVALID_PERIOD_ORG"},"key":"periodMultiple","summary":"Period macro matches several open periods","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodMultiple"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodNone":{"value":{"error":"Could not resolve $revpro.CurrPrd: no open period was found for the given book and organization.","errorCode":"INVALID_PERIOD_ORG"},"key":"periodNone","summary":"No open period for the book and organization","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodNone"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodBook":{"value":{"error":"Current or prior period could not be resolved for the selected book and organization. Specify a concrete organization or period name instead of $revpro.CurrPrd / $revpro.PriorPrd.","errorCode":"INVALID_PERIOD_ORG"},"key":"periodBook","summary":"Book could not be determined","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/periodBook"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/invalidRequest":{"value":{"error":"Invalid report request"},"key":"invalidRequest","summary":"Request could not be serialized","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/invalidRequest"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/tenant":{"value":{"timestamp":"2026-10-09T07:15:02.123+00:00","status":400,"error":"Bad Request"},"key":"tenant","summary":"Tenant could not be resolved","description":"Returned before the operation runs when the Zuora tenant of the token is not provisioned for Zuora Revenue, or the Revenue database connection could not be set up. Confirm the tenant has Zuora Revenue enabled; if it has, retry later and contact Zuora Support.","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/400/content/application~1json/examples/tenant"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/401/content/application~1json/examples/unauthorized"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/403/content/application~1json/examples/forbidden":{"value":{"message":"Failed to get user info."},"key":"forbidden","summary":"Client not entitled","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/403/content/application~1json/examples/forbidden"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/429/content/application~1json/examples/rateLimited"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/500/content/application~1json/examples/internal":{"value":{"error":"Internal server error"},"key":"internal","summary":"Submission failed","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/500/content/application~1json/examples/internal"},"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/500/content/application~1json/examples/malformedJson":{"value":{"message":"An error occurred: JSON parse error: Unexpected character ('}' (code 125))","code":"1"},"key":"malformedJson","summary":"Malformed JSON body","id":"paths/~1revenue~1services~1v1~1reports~1{reportId}~1run/post/responses/500/content/application~1json/examples/malformedJson"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/inProgress":{"value":{"id":482391,"reportId":10021,"layoutId":3105,"status":"Submitted","fileName":null,"filterParameters":"{\"filters\":[{\"key\":\"A300\",\"val1\":\"SEP-2026\"},{\"key\":\"A101\",\"val1\":\"R\"}]}","config":"{\"Show Filters\":\"Y\",\"Enable Totals\":\"N\"}","createdBy":"INTEGRATION.USER","runDate":"2026-10-09T07:15:02","updatedBy":"INTEGRATION.USER","updatedAt":"2026-10-09T07:15:02"},"key":"inProgress","summary":"Still running","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/inProgress"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/available":{"value":{"id":482391,"reportId":10021,"layoutId":3105,"status":"Available","fileName":"WF_SUMMARY_482391.csv","filterParameters":"{\"filters\":[{\"key\":\"A300\",\"val1\":\"SEP-2026\"},{\"key\":\"A101\",\"val1\":\"R\"}]}","config":"{\"Show Filters\":\"Y\",\"Enable Totals\":\"N\"}","createdBy":"INTEGRATION.USER","runDate":"2026-10-09T07:15:02","updatedBy":"INTEGRATION.USER","updatedAt":"2026-10-09T07:16:40"},"key":"available","summary":"File ready","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/available"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/failed":{"value":{"id":482377,"reportId":10021,"layoutId":3105,"status":"Error","fileName":null,"filterParameters":"{\"filters\":[{\"key\":\"A300\",\"val1\":\"SEP-2026\"},{\"key\":\"A101\",\"val1\":\"R\"}]}","config":"{\"Show Filters\":\"Y\",\"Enable Totals\":\"N\"}","createdBy":"INTEGRATION.USER","runDate":"2026-10-09T07:15:02","updatedBy":"INTEGRATION.USER","updatedAt":"2026-10-09T06:58:12"},"key":"failed","summary":"Run failed","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/200/content/application~1json/examples/failed"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/400/content/application~1json/examples/tenant":{"value":{"timestamp":"2026-10-09T07:15:02.123+00:00","status":400,"error":"Bad Request"},"key":"tenant","summary":"Tenant could not be resolved","description":"Returned before the operation runs when the Zuora tenant of the token is not provisioned for Zuora Revenue, or the Revenue database connection could not be set up. Confirm the tenant has Zuora Revenue enabled; if it has, retry later and contact Zuora Support.","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/400/content/application~1json/examples/tenant"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/403/content/application~1json/examples/forbidden":{"value":{"message":"Failed to get user info."},"key":"forbidden","summary":"Client not entitled","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/500/content/application~1json/examples/serverError":{"value":{"message":"An error occurred: Unexpected internal error","code":"1"},"key":"serverError","summary":"Unexpected error","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}/get/responses/500/content/application~1json/examples/serverError"},"paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/200/content/application~1json/examples/latest":{"value":{"id":482391,"reportId":10021,"layoutId":3105,"status":"Available","fileName":"WF_SUMMARY_482391.csv","filterParameters":"{\"filters\":[{\"key\":\"A300\",\"val1\":\"SEP-2026\"},{\"key\":\"A101\",\"val1\":\"R\"}]}","config":"{\"Show Filters\":\"Y\",\"Enable Totals\":\"N\"}","createdBy":"INTEGRATION.USER","runDate":"2026-10-09T07:15:02","updatedBy":"INTEGRATION.USER","updatedAt":"2026-10-09T07:16:40"},"key":"latest","summary":"Latest finished run","id":"paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/200/content/application~1json/examples/latest"},"paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/400/content/application~1json/examples/tenant":{"value":{"timestamp":"2026-10-09T07:15:02.123+00:00","status":400,"error":"Bad Request"},"key":"tenant","summary":"Tenant could not be resolved","description":"Returned before the operation runs when the Zuora tenant of the token is not provisioned for Zuora Revenue, or the Revenue database connection could not be set up. Confirm the tenant has Zuora Revenue enabled; if it has, retry later and contact Zuora Support.","id":"paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/400/content/application~1json/examples/tenant"},"paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/403/content/application~1json/examples/forbidden":{"value":{"message":"Failed to get user info."},"key":"forbidden","summary":"Client not entitled","id":"paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/500/content/application~1json/examples/serverError":{"value":{"message":"An error occurred: Unexpected internal error","code":"1"},"key":"serverError","summary":"Unexpected error","id":"paths/~1revenue~1services~1v1~1reports~1run~1latest/get/responses/500/content/application~1json/examples/serverError"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/200/content/application~1json/examples/url":{"value":{"presignedUrl":"https://files.zuora.com/rev/1234567/reports/WF_SUMMARY_482391.csv?X-Amz-Expires=1800&X-Amz-Signature=3b1f...","expiresAt":"2026-10-09T07:47:10"},"key":"url","summary":"URL issued","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/200/content/application~1json/examples/url"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/400/content/application~1json/examples/badRef":{"value":{"error":"Invalid report reference"},"key":"badRef","summary":"Invalid file reference","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/400/content/application~1json/examples/badRef"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/400/content/application~1json/examples/tenant":{"value":{"timestamp":"2026-10-09T07:15:02.123+00:00","status":400,"error":"Bad Request"},"key":"tenant","summary":"Tenant could not be resolved","description":"Returned before the operation runs when the Zuora tenant of the token is not provisioned for Zuora Revenue, or the Revenue database connection could not be set up. Confirm the tenant has Zuora Revenue enabled; if it has, retry later and contact Zuora Support.","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/400/content/application~1json/examples/tenant"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/403/content/application~1json/examples/forbidden":{"value":{"message":"Failed to get user info."},"key":"forbidden","summary":"Client not entitled","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/403/content/application~1json/examples/forbidden"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/409/content/application~1json/examples/notReady":{"value":{"status":"S"},"key":"notReady","summary":"Run still submitted","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/409/content/application~1json/examples/notReady"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/409/content/application~1json/examples/failed":{"value":{"status":"E"},"key":"failed","summary":"Run ended in error","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/409/content/application~1json/examples/failed"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/500/content/application~1json/examples/serverError":{"value":{"message":"An error occurred: Unexpected internal error","code":"1"},"key":"serverError","summary":"Unexpected error","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/500/content/application~1json/examples/serverError"},"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/503/content/application~1json/examples/presign":{"value":{"error":"Unable to generate download URL, please retry"},"key":"presign","summary":"Signing failed","id":"paths/~1revenue~1services~1v1~1reports~1run~1{submissionId}~1download/get/responses/503/content/application~1json/examples/presign"},"paths/~1api~1integration~1v1~1reports~1list/get/responses/200/content/application~1json/examples/files":{"value":{"Status":"Success","Message":"","Result":[{"id":482391,"file_name":"WF_SUMMARY_482391.csv","rep_name":"Revenue Waterfall Report","category":"Revenue","rep_desc":"Recognized and scheduled revenue by period for each revenue contract line","layout_name":"Monthly Close - Summary","report_date":"09-10-2026 07:15:02","status":"A"},{"id":482402,"file_name":"DEF_ROLL_482402.csv","rep_name":"Deferred Revenue Roll Forward","category":"Revenue","rep_desc":"Opening balance, additions, recognition and closing deferred revenue by period","layout_name":"Auditor Extract","report_date":"09-10-2026 08:02:44","status":"A"}]},"key":"files","summary":"Two files","id":"paths/~1api~1integration~1v1~1reports~1list/get/responses/200/content/application~1json/examples/files"},"paths/~1api~1integration~1v1~1reports~1list/get/responses/200/content/application~1json/examples/none":{"value":{"Status":"Success","Message":"","Result":[]},"key":"none","summary":"No files that day","id":"paths/~1api~1integration~1v1~1reports~1list/get/responses/200/content/application~1json/examples/none"},"paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/missing":{"value":{"Status":"Error","Message":"Mandatory field createddate is missing in path"},"key":"missing","summary":"createddate missing","id":"paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/missing"},"paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/badDate":{"value":{"Status":"Error","Message":"Invalid date format 2026-10-09 for createddate"},"key":"badDate","summary":"Wrong date format","id":"paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/badDate"},"paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/noUser":{"value":{"Status":"Error","Result":null,"Message":"Zuora-Global-User-Id header is required for OAuth authentication"},"key":"noUser","summary":"OAuth client not linked to a Zuora user","description":"The OAuth client must be created by, or mapped to, a Zuora user that has a Zuora Revenue role.","id":"paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/noUser"},"paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/dbConnect":{"value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"key":"dbConnect","summary":"Database connection failed","description":"Temporary. Retry with backoff.","id":"paths/~1api~1integration~1v1~1reports~1list/get/responses/400/content/application~1json/examples/dbConnect"},"paths/~1api~1integration~1v1~1reports~1list/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1api~1integration~1v1~1reports~1list/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1api~1integration~1v1~1reports~1list/get/responses/401/content/application~1json/examples/noRevenueUser":{"value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"key":"noRevenueUser","summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue.","id":"paths/~1api~1integration~1v1~1reports~1list/get/responses/401/content/application~1json/examples/noRevenueUser"},"paths/~1api~1integration~1v1~1reports~1list/get/responses/403/content/application~1json/examples/restricted":{"value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"key":"restricted","summary":"API not enabled for the tenant","id":"paths/~1api~1integration~1v1~1reports~1list/get/responses/403/content/application~1json/examples/restricted"},"paths/~1api~1integration~1v1~1reports~1list/get/responses/403/content/application~1json/examples/customHeaders":{"value":{"Status":"Error","Result":null,"Message":"Missing/Invalid request headers"},"key":"customHeaders","summary":"Required custom headers missing","id":"paths/~1api~1integration~1v1~1reports~1list/get/responses/403/content/application~1json/examples/customHeaders"},"paths/~1api~1integration~1v1~1reports~1list/get/responses/404/content/application~1json/examples/notFound":{"value":{"Status":"Error","Message":"No data found matching the criteria"},"key":"notFound","summary":"No data","id":"paths/~1api~1integration~1v1~1reports~1list/get/responses/404/content/application~1json/examples/notFound"},"paths/~1api~1integration~1v1~1reports~1list/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1api~1integration~1v1~1reports~1list/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1api~1integration~1v1~1reports~1list/get/responses/500/content/application~1json/examples/dbError":{"value":{"Status":"Error","Result":null,"Message":"Unexpected Error. Please contact Zuora Revenue Support"},"key":"dbError","summary":"Database error","id":"paths/~1api~1integration~1v1~1reports~1list/get/responses/500/content/application~1json/examples/dbError"},"paths/~1api~1integration~1v1~1reports~1list/get/responses/502/content/application~1json/examples/queryService":{"value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"key":"queryService","summary":"Query service error","id":"paths/~1api~1integration~1v1~1reports~1list/get/responses/502/content/application~1json/examples/queryService"},"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/200/content/application~1json/examples/ready":{"value":{"Status":"Success","Message":"","Result":[{"id":482391,"file_name":"WF_SUMMARY_482391.csv","rep_name":"Revenue Waterfall Report","category":"Revenue","rep_desc":"Recognized and scheduled revenue by period for each revenue contract line","layout_name":"Monthly Close - Summary","report_date":"09-10-2026 07:15:02","status":"A"}]},"key":"ready","summary":"File ready","id":"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/200/content/application~1json/examples/ready"},"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/200/content/application~1json/examples/notReady":{"value":{"Status":"Success","Message":"","Result":[]},"key":"notReady","summary":"Not Available yet, or not visible","id":"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/200/content/application~1json/examples/notReady"},"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/400/content/application~1json/examples/noUser":{"value":{"Status":"Error","Result":null,"Message":"Zuora-Global-User-Id header is required for OAuth authentication"},"key":"noUser","summary":"OAuth client not linked to a Zuora user","description":"The OAuth client must be created by, or mapped to, a Zuora user that has a Zuora Revenue role.","id":"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/400/content/application~1json/examples/noUser"},"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/400/content/application~1json/examples/dbConnect":{"value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"key":"dbConnect","summary":"Database connection failed","description":"Temporary. Retry with backoff.","id":"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/400/content/application~1json/examples/dbConnect"},"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/401/content/application~1json/examples/noRevenueUser":{"value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"key":"noRevenueUser","summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue.","id":"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/401/content/application~1json/examples/noRevenueUser"},"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/403/content/application~1json/examples/restricted":{"value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"key":"restricted","summary":"API not enabled for the tenant","id":"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/403/content/application~1json/examples/restricted"},"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/403/content/application~1json/examples/customHeaders":{"value":{"Status":"Error","Result":null,"Message":"Missing/Invalid request headers"},"key":"customHeaders","summary":"Required custom headers missing","id":"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/403/content/application~1json/examples/customHeaders"},"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/404/content/application~1json/examples/notFound":{"value":{"Status":"Error","Message":"No data found matching the criteria"},"key":"notFound","summary":"No data","id":"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/404/content/application~1json/examples/notFound"},"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/500/content/application~1json/examples/dbError":{"value":{"Status":"Error","Result":null,"Message":"Unexpected Error. Please contact Zuora Revenue Support"},"key":"dbError","summary":"Database error","id":"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/500/content/application~1json/examples/dbError"},"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/502/content/application~1json/examples/queryService":{"value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"key":"queryService","summary":"Query service error","id":"paths/~1api~1integration~1v1~1reports~1{report_id}/get/responses/502/content/application~1json/examples/queryService"},"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/200/content/application~1json/examples/recent":{"value":{"Status":"Success","Message":"","Result":[{"id":482402,"file_name":"DEF_ROLL_482402.csv","rep_name":"Deferred Revenue Roll Forward","category":"Revenue","rep_desc":"Opening balance, additions, recognition and closing deferred revenue by period","layout_name":"Auditor Extract","report_date":"09-10-2026 08:02:44","status":"A"},{"id":482391,"file_name":"WF_SUMMARY_482391.csv","rep_name":"Revenue Waterfall Report","category":"Revenue","rep_desc":"Recognized and scheduled revenue by period for each revenue contract line","layout_name":"Monthly Close - Summary","report_date":"09-10-2026 07:15:02","status":"A"}]},"key":"recent","summary":"Two most recent files","id":"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/200/content/application~1json/examples/recent"},"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/400/content/application~1json/examples/noUser":{"value":{"Status":"Error","Result":null,"Message":"Zuora-Global-User-Id header is required for OAuth authentication"},"key":"noUser","summary":"OAuth client not linked to a Zuora user","description":"The OAuth client must be created by, or mapped to, a Zuora user that has a Zuora Revenue role.","id":"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/400/content/application~1json/examples/noUser"},"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/400/content/application~1json/examples/dbConnect":{"value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"key":"dbConnect","summary":"Database connection failed","description":"Temporary. Retry with backoff.","id":"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/400/content/application~1json/examples/dbConnect"},"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/401/content/application~1json/examples/noRevenueUser":{"value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"key":"noRevenueUser","summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue.","id":"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/401/content/application~1json/examples/noRevenueUser"},"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/403/content/application~1json/examples/restricted":{"value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"key":"restricted","summary":"API not enabled for the tenant","id":"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/403/content/application~1json/examples/restricted"},"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/403/content/application~1json/examples/customHeaders":{"value":{"Status":"Error","Result":null,"Message":"Missing/Invalid request headers"},"key":"customHeaders","summary":"Required custom headers missing","id":"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/403/content/application~1json/examples/customHeaders"},"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/404/content/application~1json/examples/notFound":{"value":{"Status":"Error","Message":"No data found matching the criteria"},"key":"notFound","summary":"No data","id":"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/404/content/application~1json/examples/notFound"},"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/500/content/application~1json/examples/dbError":{"value":{"Status":"Error","Result":null,"Message":"Unexpected Error. Please contact Zuora Revenue Support"},"key":"dbError","summary":"Database error","id":"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/500/content/application~1json/examples/dbError"},"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/502/content/application~1json/examples/queryService":{"value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"key":"queryService","summary":"Query service error","id":"paths/~1api~1integration~1v1~1reports~1recent-n~1{number_of_records}/get/responses/502/content/application~1json/examples/queryService"},"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/200/content/application~1octet-stream/examples/csv":{"value":"\"Period Name\",\"Revenue Contract ID\",\"Recognized Amount\"\n\"SEP-2026\",\"120045\",\"1000.00\"\n","key":"csv","summary":"CSV file bytes","id":"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/200/content/application~1octet-stream/examples/csv"},"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/noPath":{"value":{"Status":"Error","Result":null,"Message":"Failed to derive Report FilePath"},"key":"noPath","summary":"File store not available","id":"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/noPath"},"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/noUser":{"value":{"Status":"Error","Result":null,"Message":"Zuora-Global-User-Id header is required for OAuth authentication"},"key":"noUser","summary":"OAuth client not linked to a Zuora user","description":"The OAuth client must be created by, or mapped to, a Zuora user that has a Zuora Revenue role.","id":"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/noUser"},"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/dbConnect":{"value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"key":"dbConnect","summary":"Database connection failed","description":"Temporary. Retry with backoff.","id":"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/400/content/application~1json/examples/dbConnect"},"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/401/content/application~1json/examples/noRevenueUser":{"value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"key":"noRevenueUser","summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue.","id":"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/401/content/application~1json/examples/noRevenueUser"},"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/403/content/application~1json/examples/restricted":{"value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"key":"restricted","summary":"API not enabled for the tenant","id":"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/403/content/application~1json/examples/restricted"},"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/403/content/application~1json/examples/customHeaders":{"value":{"Status":"Error","Result":null,"Message":"Missing/Invalid request headers"},"key":"customHeaders","summary":"Required custom headers missing","id":"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/403/content/application~1json/examples/customHeaders"},"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/500/content/application~1json/examples/dbError":{"value":{"Status":"Error","Result":null,"Message":"Unexpected Error. Please contact Zuora Revenue Support"},"key":"dbError","summary":"Database error","id":"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/500/content/application~1json/examples/dbError"},"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/502/content/application~1json/examples/queryService":{"value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"key":"queryService","summary":"Query service error","id":"paths/~1api~1integration~1v1~1reports~1download~1{filename}/get/responses/502/content/application~1json/examples/queryService"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/200/content/application~1json/examples/url":{"value":{"success":true,"signed_url":"https://files.zuora.com/rev/1234567/reports/WF_SUMMARY_482391.csv?X-Amz-Expires=1800&X-Amz-Signature=9ac2..."},"key":"url","summary":"URL issued","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/200/content/application~1json/examples/url"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/400/content/application~1json/examples/signing":{"value":{"Status":"Object of type Response is not JSON serializable","Result":{}},"key":"signing","summary":"Signing service error","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/400/content/application~1json/examples/signing"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/400/content/application~1json/examples/dbConnect":{"value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"key":"dbConnect","summary":"Database connection failed","description":"Temporary. Retry with backoff.","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/400/content/application~1json/examples/dbConnect"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/401/content/application~1json/examples/noRevenueUser":{"value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"key":"noRevenueUser","summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue.","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/401/content/application~1json/examples/noRevenueUser"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/403/content/application~1json/examples/getDisabled":{"value":{"Status":"Error","Result":null,"Message":"HTTP GET API is disabled for this tenant"},"key":"getDisabled","summary":"GET disabled","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/403/content/application~1json/examples/getDisabled"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/403/content/application~1json/examples/restricted":{"value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"key":"restricted","summary":"API not enabled","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/403/content/application~1json/examples/restricted"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/404/content/application~1json/examples/notFound":{"value":{"success":false,"error":"Report not found for Submission Id: 482399"},"key":"notFound","summary":"Run not found or not ready","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/404/content/application~1json/examples/notFound"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/404/content/application~1json/examples/notConfigured":{"value":{"success":false,"error":"Unable to generate URL. Please contact Zuora Revenue Support"},"key":"notConfigured","summary":"Signing not configured","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/404/content/application~1json/examples/notConfigured"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/500/content/application~1json/examples/dbError":{"value":{"Status":"Error","Result":null,"Message":"Unexpected Error. Please contact Zuora Revenue Support"},"key":"dbError","summary":"Database error","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/500/content/application~1json/examples/dbError"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/502/content/application~1json/examples/queryService":{"value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"key":"queryService","summary":"Query service error","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/get/responses/502/content/application~1json/examples/queryService"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/200/content/application~1json/examples/url":{"value":{"success":true,"signed_url":"https://files.zuora.com/rev/1234567/reports/WF_SUMMARY_482391.csv?X-Amz-Expires=1800&X-Amz-Signature=9ac2..."},"key":"url","summary":"URL issued","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/200/content/application~1json/examples/url"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/400/content/application~1json/examples/signing":{"value":{"Status":"Object of type Response is not JSON serializable","Result":{}},"key":"signing","summary":"Signing service error","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/400/content/application~1json/examples/signing"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/400/content/application~1json/examples/dbConnect":{"value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"key":"dbConnect","summary":"Database connection failed","description":"Temporary. Retry with backoff.","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/400/content/application~1json/examples/dbConnect"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/401/content/application~1json/examples/unauthorized"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/401/content/application~1json/examples/noRevenueUser":{"value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"key":"noRevenueUser","summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue.","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/401/content/application~1json/examples/noRevenueUser"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/403/content/application~1json/examples/getDisabled":{"value":{"Status":"Error","Result":null,"Message":"HTTP GET API is disabled for this tenant"},"key":"getDisabled","summary":"GET disabled","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/403/content/application~1json/examples/getDisabled"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/403/content/application~1json/examples/restricted":{"value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"key":"restricted","summary":"API not enabled","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/403/content/application~1json/examples/restricted"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/404/content/application~1json/examples/notFound":{"value":{"success":false,"error":"Report not found for Submission Id: 482399"},"key":"notFound","summary":"Run not found or not ready","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/404/content/application~1json/examples/notFound"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/404/content/application~1json/examples/notConfigured":{"value":{"success":false,"error":"Unable to generate URL. Please contact Zuora Revenue Support"},"key":"notConfigured","summary":"Signing not configured","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/404/content/application~1json/examples/notConfigured"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/429/content/application~1json/examples/rateLimited"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/500/content/application~1json/examples/dbError":{"value":{"Status":"Error","Result":null,"Message":"Unexpected Error. Please contact Zuora Revenue Support"},"key":"dbError","summary":"Database error","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/500/content/application~1json/examples/dbError"},"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/502/content/application~1json/examples/queryService":{"value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"key":"queryService","summary":"Query service error","id":"paths/~1api~1integration~1v2~1reports~1signedurl~1{report_id}/post/responses/502/content/application~1json/examples/queryService"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/200/content/text~1csv/examples/csvPage":{"value":"\"RC_ID\",\"RC_NUM\",\"LINE_ID\",\"EXT_SLL_PRC\",\"UPDT_DT\"\n\"120045\",\"RC-120045\",\"880113\",\"12000\",\"2026-09-14 10:22:05\"\n","key":"csvPage","summary":"Page 1 as CSV (outputType=csv)","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/200/content/text~1csv/examples/csvPage"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/200/content/application~1gzip/examples/gzipPage":{"value":"<binary gzip-compressed CSV>","key":"gzipPage","summary":"Page 1 as gzip (default outputType)","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/200/content/application~1gzip/examples/gzipPage"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/missingParam":{"value":{"Status":"Error","Message":"Mandatory field fromDate is missing in path"},"key":"missingParam","summary":"fromDate missing","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/missingParam"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badDate":{"value":{"Status":"Error","Message":"Invalid date format 2026-09-01 for fromDate"},"key":"badDate","summary":"Wrong date format","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badDate"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/noToken":{"value":{"Status":"Error","Result":"Continuation-Token is Mandatory in request header for Pages greater than 1"},"key":"noToken","summary":"continuation-token missing for page 2","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/noToken"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/pageSize":{"value":{"Status":"Error","Message":"pageSize cannot exceed 10000. Provided value was 15000.. Max limit for CSV format is 10000, GZIP format is 20000. Use outputType parameter to specify format. If you want more than 10000 records per page, please provide the outputType='gzip'"},"key":"pageSize","summary":"pageSize too large","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/pageSize"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badField":{"value":{"Status":"Error","Message":"One or more fields from ['RC_ID', 'RC_NUMBER'] does not exist. For list of valid fields use the describe view api /integration/v2/biviews/<string:tmpl_name>/describe-columns"},"key":"badField","summary":"Unknown column in Fields","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badField"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView":{"value":{"Status":"Error","Message":"('BI3_RC_LINES', {'BI3_ACCT_TYPE': 'RPRO_BI3_ACCT_TYPE_V', '...': '...'}, None)"},"key":"badView","summary":"Unknown BI View name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The message lists the requested name and the views supported for the tenant. Correct the name using the list in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tmpl_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" description."},"children":[]}]}]}],"id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/notCached":{"value":{"Status":"Error","Result":"Page still not yet cached. Please retry."},"key":"notCached","summary":"Later page not ready yet","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/notCached"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/quota":{"value":{"Status":"Error","Message":"Reached allocated limits. Quota: Maximum Queries: 5 and Maximum Number of Queries per object: 2. <current usage>."},"key":"quota","summary":"Query quota reached","description":"Wait for running tasks to finish (see List BI View tasks) or cancel tasks you no longer need.","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/quota"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect":{"value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"key":"dbConnect","summary":"Database connection failed","description":"Temporary. Retry with backoff.","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser":{"value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"key":"noRevenueUser","summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue.","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted":{"value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"key":"restricted","summary":"API not enabled for the tenant","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders":{"value":{"Status":"Error","Result":null,"Message":"Missing/Invalid request headers"},"key":"customHeaders","summary":"Required custom headers missing","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/404/content/application~1json/examples/lastPage":{"value":{"Status":"Success","Result":"This page will not exist. Total Pages available are 3. Number of rows across these pages are 12430"},"key":"lastPage","summary":"Past the last page","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/404/content/application~1json/examples/lastPage"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/500/content/application~1json/examples/worker":{"value":{"Status":"Error","Result":"Unable to process job. Please retry"},"key":"worker","summary":"Worker lost","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/500/content/application~1json/examples/worker"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService":{"value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"key":"queryService","summary":"Query service error","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/fields":{"value":{"Fields":["RC_ID","RC_NUM","UPDT_DT"]},"key":"fields","summary":"Select three columns","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/fields"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/array":{"value":["RC_ID","RC_NUM","UPDT_DT"],"key":"array","summary":"Plain array form","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/array"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/200/content/text~1csv/examples/csvPage":{"value":"\"RC_ID\",\"RC_NUM\",\"LINE_ID\",\"EXT_SLL_PRC\",\"UPDT_DT\"\n\"120045\",\"RC-120045\",\"880113\",\"12000\",\"2026-09-14 10:22:05\"\n","key":"csvPage","summary":"Page 1 as CSV (outputType=csv)","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/200/content/text~1csv/examples/csvPage"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/200/content/application~1gzip/examples/gzipPage":{"value":"<binary gzip-compressed CSV>","key":"gzipPage","summary":"Page 1 as gzip (default outputType)","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/200/content/application~1gzip/examples/gzipPage"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/missingParam":{"value":{"Status":"Error","Message":"Mandatory field fromDate is missing in path"},"key":"missingParam","summary":"fromDate missing","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/missingParam"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badDate":{"value":{"Status":"Error","Message":"Invalid date format 2026-09-01 for fromDate"},"key":"badDate","summary":"Wrong date format","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badDate"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/noToken":{"value":{"Status":"Error","Result":"Continuation-Token is Mandatory in request header for Pages greater than 1"},"key":"noToken","summary":"continuation-token missing for page 2","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/noToken"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/pageSize":{"value":{"Status":"Error","Message":"pageSize cannot exceed 10000. Provided value was 15000.. Max limit for CSV format is 10000, GZIP format is 20000. Use outputType parameter to specify format. If you want more than 10000 records per page, please provide the outputType='gzip'"},"key":"pageSize","summary":"pageSize too large","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/pageSize"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badField":{"value":{"Status":"Error","Message":"One or more fields from ['RC_ID', 'RC_NUMBER'] does not exist. For list of valid fields use the describe view api /integration/v2/biviews/<string:tmpl_name>/describe-columns"},"key":"badField","summary":"Unknown column in Fields","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badField"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badView":{"value":{"Status":"Error","Message":"('BI3_RC_LINES', {'BI3_ACCT_TYPE': 'RPRO_BI3_ACCT_TYPE_V', '...': '...'}, None)"},"key":"badView","summary":"Unknown BI View name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The message lists the requested name and the views supported for the tenant. Correct the name using the list in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tmpl_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" description."},"children":[]}]}]}],"id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badView"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/notCached":{"value":{"Status":"Error","Result":"Page still not yet cached. Please retry."},"key":"notCached","summary":"Later page not ready yet","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/notCached"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/quota":{"value":{"Status":"Error","Message":"Reached allocated limits. Quota: Maximum Queries: 5 and Maximum Number of Queries per object: 2. <current usage>."},"key":"quota","summary":"Query quota reached","description":"Wait for running tasks to finish (see List BI View tasks) or cancel tasks you no longer need.","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/quota"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dbConnect":{"value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"key":"dbConnect","summary":"Database connection failed","description":"Temporary. Retry with backoff.","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dbConnect"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/unauthorized"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/noRevenueUser":{"value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"key":"noRevenueUser","summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue.","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/noRevenueUser"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/restricted":{"value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"key":"restricted","summary":"API not enabled for the tenant","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/restricted"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/customHeaders":{"value":{"Status":"Error","Result":null,"Message":"Missing/Invalid request headers"},"key":"customHeaders","summary":"Required custom headers missing","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/customHeaders"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/404/content/application~1json/examples/lastPage":{"value":{"Status":"Success","Result":"This page will not exist. Total Pages available are 3. Number of rows across these pages are 12430"},"key":"lastPage","summary":"Past the last page","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/404/content/application~1json/examples/lastPage"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/429/content/application~1json/examples/rateLimited"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/500/content/application~1json/examples/worker":{"value":{"Status":"Error","Result":"Unable to process job. Please retry"},"key":"worker","summary":"Worker lost","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/500/content/application~1json/examples/worker"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/502/content/application~1json/examples/queryService":{"value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"key":"queryService","summary":"Query service error","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}/post/responses/502/content/application~1json/examples/queryService"},"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/200/content/application~1json/examples/count":{"value":{"count":12430},"key":"count","summary":"Row count","id":"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/200/content/application~1json/examples/count"},"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/missingParam":{"value":{"Status":"Error","Message":"Mandatory field toDate is missing in path"},"key":"missingParam","summary":"toDate missing","id":"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/missingParam"},"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/badDate":{"value":{"Status":"Error","Message":"Invalid date format 09/30/2026 for toDate"},"key":"badDate","summary":"Wrong date format","id":"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/badDate"},"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView":{"value":{"Status":"Error","Message":"('BI3_RC_LINES', {'BI3_ACCT_TYPE': 'RPRO_BI3_ACCT_TYPE_V', '...': '...'}, None)"},"key":"badView","summary":"Unknown BI View name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The message lists the requested name and the views supported for the tenant. Correct the name using the list in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tmpl_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" description."},"children":[]}]}]}],"id":"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView"},"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect":{"value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"key":"dbConnect","summary":"Database connection failed","description":"Temporary. Retry with backoff.","id":"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect"},"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser":{"value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"key":"noRevenueUser","summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue.","id":"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser"},"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted":{"value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"key":"restricted","summary":"API not enabled for the tenant","id":"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted"},"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders":{"value":{"Status":"Error","Result":null,"Message":"Missing/Invalid request headers"},"key":"customHeaders","summary":"Required custom headers missing","id":"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders"},"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/500/content/application~1json/examples/dbError":{"value":{"Status":"Error","Result":null,"Message":"Unexpected Error. Please contact Zuora Revenue Support"},"key":"dbError","summary":"Database error","id":"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/500/content/application~1json/examples/dbError"},"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService":{"value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"key":"queryService","summary":"Query service error","id":"paths/~1api~1integration~1v2~1biviews~1count~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/200/content/text~1html/examples/columns":{"value":[{"column_name":"RC_ID","data_type":"NUMBER","data_length":22,"data_precision":null,"data_scale":null},{"column_name":"RC_NUM","data_type":"VARCHAR2","data_length":200,"data_precision":null,"data_scale":null},{"column_name":"UPDT_DT","data_type":"DATE","data_length":7,"data_precision":null,"data_scale":null}],"key":"columns","summary":"Columns","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/200/content/text~1html/examples/columns"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/400/content/application~1json/examples/badView":{"value":{"Status":"Error","Message":"('BI3_RC_LINES', {'BI3_ACCT_TYPE': 'RPRO_BI3_ACCT_TYPE_V', '...': '...'}, None)"},"key":"badView","summary":"Unknown BI View name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The message lists the requested name and the views supported for the tenant. Correct the name using the list in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tmpl_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" description."},"children":[]}]}]}],"id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/400/content/application~1json/examples/badView"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/400/content/application~1json/examples/dbConnect":{"value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"key":"dbConnect","summary":"Database connection failed","description":"Temporary. Retry with backoff.","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/400/content/application~1json/examples/dbConnect"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/401/content/application~1json/examples/noRevenueUser":{"value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"key":"noRevenueUser","summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue.","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/401/content/application~1json/examples/noRevenueUser"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/403/content/application~1json/examples/restricted":{"value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"key":"restricted","summary":"API not enabled for the tenant","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/403/content/application~1json/examples/restricted"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/403/content/application~1json/examples/customHeaders":{"value":{"Status":"Error","Result":null,"Message":"Missing/Invalid request headers"},"key":"customHeaders","summary":"Required custom headers missing","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/403/content/application~1json/examples/customHeaders"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/500/content/application~1json/examples/dbError":{"value":{"Status":"Error","Result":null,"Message":"Unexpected Error. Please contact Zuora Revenue Support"},"key":"dbError","summary":"Database error","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/500/content/application~1json/examples/dbError"},"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/502/content/application~1json/examples/queryService":{"value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"key":"queryService","summary":"Query service error","id":"paths/~1api~1integration~1v2~1biviews~1{tmpl_name}~1describe-columns/get/responses/502/content/application~1json/examples/queryService"},"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/200/content/application~1json/examples/accepted":{"value":{"success":true,"report_id":482455},"key":"accepted","summary":"Job accepted","id":"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/200/content/application~1json/examples/accepted"},"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/missingParam":{"value":{"Status":"Error","Message":"Mandatory field fromDate is missing in path"},"key":"missingParam","summary":"fromDate missing","id":"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/missingParam"},"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/badDate":{"value":{"Status":"Error","Message":"Invalid date format 2026-09-01 for fromDate"},"key":"badDate","summary":"Wrong date format","id":"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/badDate"},"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/rejected":{"value":{"success":false,"message":"Unable to submit"},"key":"rejected","summary":"Job rejected","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds the reason returned by Zuora Revenue, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unable to submit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"id":"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/rejected"},"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/badView":{"value":{"Status":"Error","Message":"('BI3_RC_LINES', {'BI3_ACCT_TYPE': 'RPRO_BI3_ACCT_TYPE_V', '...': '...'}, None)"},"key":"badView","summary":"Unknown BI View name","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The message lists the requested name and the views supported for the tenant. Correct the name using the list in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tmpl_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" description."},"children":[]}]}]}],"id":"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/badView"},"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/dbConnect":{"value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"key":"dbConnect","summary":"Database connection failed","description":"Temporary. Retry with backoff.","id":"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/400/content/application~1json/examples/dbConnect"},"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/401/content/application~1json/examples/unauthorized"},"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/401/content/application~1json/examples/noRevenueUser":{"value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"key":"noRevenueUser","summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue.","id":"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/401/content/application~1json/examples/noRevenueUser"},"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/403/content/application~1json/examples/restricted":{"value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"key":"restricted","summary":"API not enabled for the tenant","id":"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/403/content/application~1json/examples/restricted"},"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/403/content/application~1json/examples/customHeaders":{"value":{"Status":"Error","Result":null,"Message":"Missing/Invalid request headers"},"key":"customHeaders","summary":"Required custom headers missing","id":"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/403/content/application~1json/examples/customHeaders"},"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/429/content/application~1json/examples/rateLimited"},"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/500/content/application~1json/examples/dbError":{"value":{"Status":"Error","Result":null,"Message":"Unexpected Error. Please contact Zuora Revenue Support"},"key":"dbError","summary":"Database error","id":"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/500/content/application~1json/examples/dbError"},"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/502/content/application~1json/examples/queryService":{"value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"key":"queryService","summary":"Query service error","id":"paths/~1api~1integration~1v2~1biviews~1report~1{in_view_name}/post/responses/502/content/application~1json/examples/queryService"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/200/content/text~1html/examples/rows":{"value":"\"120045\",\"RC-120045\",\"USD\",\"2026-09-14 10:22:05\"\n\"120046\",\"RC-120046\",\"EUR\",\"2026-09-15 08:01:44\"\n","key":"rows","summary":"CSV rows","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/200/content/text~1html/examples/rows"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/200/content/application~1json/examples/count":{"value":{"Status":"Success","Result":{"count":12430}},"key":"count","summary":"Row count (count=true)","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/200/content/application~1json/examples/count"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/200/content/application~1json/examples/columns":{"value":{"Status":[{"column_name":"RC_ID","data_type":"NUMBER","data_length":22},{"column_name":"RC_NUM","data_type":"VARCHAR2","data_length":200}],"Result":{}},"key":"columns","summary":"Columns (no dates)","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/200/content/application~1json/examples/columns"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView":{"value":{"Status":"Template does not exist","Result":["BI3_ACCT_TYPE","BI3_APPR_DTL","BI3_BOOK","..."]},"key":"badView","summary":"Unknown view","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badView"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badClient":{"value":{"Status":"ClientId is invalid","Result":{}},"key":"badClient","summary":"clientId invalid","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badClient"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dateOrder":{"value":{"Status":"ToDate must be greater than FromDate","Result":{}},"key":"dateOrder","summary":"toDate before fromDate","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dateOrder"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dateFormat":{"value":{"Status":"Error in date format expected format is :2016-07-26T00:00:00","Result":{}},"key":"dateFormat","summary":"Wrong date format","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dateFormat"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badBody":{"value":{"Status":"No Json body found for POST","Result":{}},"key":"badBody","summary":"POST body not JSON","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badBody"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badField":{"value":{"Status":"Invalid Fields","Message":{"Invalid_fields":["RC_NUMBER"]},"Result":{}},"key":"badField","summary":"Unknown column","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/badField"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/countFailed":{"value":{"Status":"Error","Message":"Error retrieving BI View Count","Result":{"count":0}},"key":"countFailed","summary":"Row count failed","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/countFailed"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect":{"value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"key":"dbConnect","summary":"Database connection failed","description":"Temporary. Retry with backoff.","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/400/content/application~1json/examples/dbConnect"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser":{"value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"key":"noRevenueUser","summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue.","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/401/content/application~1json/examples/noRevenueUser"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted":{"value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"key":"restricted","summary":"API not enabled for the tenant","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/restricted"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders":{"value":{"Status":"Error","Result":null,"Message":"Missing/Invalid request headers"},"key":"customHeaders","summary":"Required custom headers missing","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/403/content/application~1json/examples/customHeaders"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/500/content/application~1json/examples/meta":{"value":{"Status":"Error occurred while fetching column metadata for the given view","Result":{}},"key":"meta","summary":"Metadata error","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/500/content/application~1json/examples/meta"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService":{"value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"key":"queryService","summary":"Query service error","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/get/responses/502/content/application~1json/examples/queryService"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/fields":{"value":{"Fields":["RC_ID","RC_NUM"]},"key":"fields","summary":"Select two columns","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/requestBody/content/application~1json/examples/fields"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/200/content/text~1html/examples/rows":{"value":"\"120045\",\"RC-120045\",\"USD\",\"2026-09-14 10:22:05\"\n\"120046\",\"RC-120046\",\"EUR\",\"2026-09-15 08:01:44\"\n","key":"rows","summary":"CSV rows","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/200/content/text~1html/examples/rows"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/200/content/application~1json/examples/count":{"value":{"Status":"Success","Result":{"count":12430}},"key":"count","summary":"Row count (count=true)","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/200/content/application~1json/examples/count"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/200/content/application~1json/examples/columns":{"value":{"Status":[{"column_name":"RC_ID","data_type":"NUMBER","data_length":22},{"column_name":"RC_NUM","data_type":"VARCHAR2","data_length":200}],"Result":{}},"key":"columns","summary":"Columns (no dates)","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/200/content/application~1json/examples/columns"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badView":{"value":{"Status":"Template does not exist","Result":["BI3_ACCT_TYPE","BI3_APPR_DTL","BI3_BOOK","..."]},"key":"badView","summary":"Unknown view","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badView"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badClient":{"value":{"Status":"ClientId is invalid","Result":{}},"key":"badClient","summary":"clientId invalid","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badClient"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dateOrder":{"value":{"Status":"ToDate must be greater than FromDate","Result":{}},"key":"dateOrder","summary":"toDate before fromDate","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dateOrder"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dateFormat":{"value":{"Status":"Error in date format expected format is :2016-07-26T00:00:00","Result":{}},"key":"dateFormat","summary":"Wrong date format","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dateFormat"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badBody":{"value":{"Status":"No Json body found for POST","Result":{}},"key":"badBody","summary":"POST body not JSON","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badBody"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badField":{"value":{"Status":"Invalid Fields","Message":{"Invalid_fields":["RC_NUMBER"]},"Result":{}},"key":"badField","summary":"Unknown column","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/badField"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/countFailed":{"value":{"Status":"Error","Message":"Error retrieving BI View Count","Result":{"count":0}},"key":"countFailed","summary":"Row count failed","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/countFailed"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dbConnect":{"value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"key":"dbConnect","summary":"Database connection failed","description":"Temporary. Retry with backoff.","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/400/content/application~1json/examples/dbConnect"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/unauthorized"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/noRevenueUser":{"value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"key":"noRevenueUser","summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue.","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/401/content/application~1json/examples/noRevenueUser"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/restricted":{"value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"key":"restricted","summary":"API not enabled for the tenant","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/restricted"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/customHeaders":{"value":{"Status":"Error","Result":null,"Message":"Missing/Invalid request headers"},"key":"customHeaders","summary":"Required custom headers missing","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/403/content/application~1json/examples/customHeaders"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/429/content/application~1json/examples/rateLimited"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/500/content/application~1json/examples/meta":{"value":{"Status":"Error occurred while fetching column metadata for the given view","Result":{}},"key":"meta","summary":"Metadata error","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/500/content/application~1json/examples/meta"},"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/502/content/application~1json/examples/queryService":{"value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"key":"queryService","summary":"Query service error","id":"paths/~1api~1integration~1v1~1biviews~1{tmpl_name}/post/responses/502/content/application~1json/examples/queryService"},"paths/~1api~1integration~1v2~1biviews-status/get/responses/200/content/application~1json/examples/tasks":{"value":{"active":[{"task_id":"3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4","status":"COMMITING-PAGE-3","message":null,"metric":1000,"accumulate":3000,"query_config":{"object_name":"RPRO_BI3_RC_LNS_V","filter_params":{"fromDate":"2026-09-01 00:00:00","toDate":"2026-09-30 23:59:59"}},"activity_tracker":{"initated_time":"2026-10-09T07:20:01.512000","last_activity":"2026-10-09T07:21:44.008000","elapsed_time":"0:00:03.112000"}}],"completed":[],"stale":[],"draining":[]},"key":"tasks","summary":"One active task","id":"paths/~1api~1integration~1v2~1biviews-status/get/responses/200/content/application~1json/examples/tasks"},"paths/~1api~1integration~1v2~1biviews-status/get/responses/400/content/application~1json/examples/dbConnect":{"value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"key":"dbConnect","summary":"Database connection failed","description":"Temporary. Retry with backoff.","id":"paths/~1api~1integration~1v2~1biviews-status/get/responses/400/content/application~1json/examples/dbConnect"},"paths/~1api~1integration~1v2~1biviews-status/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1api~1integration~1v2~1biviews-status/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1api~1integration~1v2~1biviews-status/get/responses/401/content/application~1json/examples/noRevenueUser":{"value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"key":"noRevenueUser","summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue.","id":"paths/~1api~1integration~1v2~1biviews-status/get/responses/401/content/application~1json/examples/noRevenueUser"},"paths/~1api~1integration~1v2~1biviews-status/get/responses/403/content/application~1json/examples/restricted":{"value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"key":"restricted","summary":"API not enabled for the tenant","id":"paths/~1api~1integration~1v2~1biviews-status/get/responses/403/content/application~1json/examples/restricted"},"paths/~1api~1integration~1v2~1biviews-status/get/responses/403/content/application~1json/examples/customHeaders":{"value":{"Status":"Error","Result":null,"Message":"Missing/Invalid request headers"},"key":"customHeaders","summary":"Required custom headers missing","id":"paths/~1api~1integration~1v2~1biviews-status/get/responses/403/content/application~1json/examples/customHeaders"},"paths/~1api~1integration~1v2~1biviews-status/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1api~1integration~1v2~1biviews-status/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1api~1integration~1v2~1biviews-status/get/responses/500/content/application~1json/examples/dbError":{"value":{"Status":"Error","Result":null,"Message":"Unexpected Error. Please contact Zuora Revenue Support"},"key":"dbError","summary":"Database error","id":"paths/~1api~1integration~1v2~1biviews-status/get/responses/500/content/application~1json/examples/dbError"},"paths/~1api~1integration~1v2~1biviews-status/get/responses/502/content/application~1json/examples/queryService":{"value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"key":"queryService","summary":"Query service error","id":"paths/~1api~1integration~1v2~1biviews-status/get/responses/502/content/application~1json/examples/queryService"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/200/content/application~1json/examples/task":{"value":{"task_id":"3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4","status":"SCANNING-PAGE-4","message":null,"metric":1000,"accumulate":3000,"query_config":{"object_name":"RPRO_BI3_RC_LNS_V","filter_params":{"fromDate":"2026-09-01 00:00:00","toDate":"2026-09-30 23:59:59"}},"activity_tracker":{"initated_time":"2026-10-09T07:20:01.512000","last_activity":"2026-10-09T07:22:10.330000","elapsed_time":"0:00:01.870000"}},"key":"task","summary":"Task in progress","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/200/content/application~1json/examples/task"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/400/content/application~1json/examples/dbConnect":{"value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"key":"dbConnect","summary":"Database connection failed","description":"Temporary. Retry with backoff.","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/400/content/application~1json/examples/dbConnect"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/401/content/application~1json/examples/unauthorized"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/401/content/application~1json/examples/noRevenueUser":{"value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"key":"noRevenueUser","summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue.","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/401/content/application~1json/examples/noRevenueUser"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/403/content/application~1json/examples/restricted":{"value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"key":"restricted","summary":"API not enabled for the tenant","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/403/content/application~1json/examples/restricted"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/403/content/application~1json/examples/customHeaders":{"value":{"Status":"Error","Result":null,"Message":"Missing/Invalid request headers"},"key":"customHeaders","summary":"Required custom headers missing","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/403/content/application~1json/examples/customHeaders"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/429/content/application~1json/examples/rateLimited"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/500/content/application~1json/examples/dbError":{"value":{"Status":"Error","Result":null,"Message":"Unexpected Error. Please contact Zuora Revenue Support"},"key":"dbError","summary":"Database error","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/500/content/application~1json/examples/dbError"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/502/content/application~1json/examples/queryService":{"value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"key":"queryService","summary":"Query service error","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/get/responses/502/content/application~1json/examples/queryService"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/200/content/application~1json/examples/cancelled":{"value":{"task_id":"3f6c2d0a-8b1e-4f7a-9d2c-55e1a7b0c9f4","status":"CANCELLED","message":null,"metric":1000,"accumulate":4000,"query_config":{"object_name":"RPRO_BI3_RC_LNS_V","filter_params":{"fromDate":"2026-09-01 00:00:00","toDate":"2026-09-30 23:59:59"}},"activity_tracker":{"initated_time":"2026-10-09T07:20:01.512000","last_activity":"2026-10-09T07:23:00.101000","elapsed_time":"0:00:00.004000"}},"key":"cancelled","summary":"Task cancelled","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/200/content/application~1json/examples/cancelled"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/400/content/application~1json/examples/dbConnect":{"value":{"Status":"Error","Result":null,"Message":"Error connecting to database. Please retry after sometime.  If this issue persists, please call Zuora Revenue Support"},"key":"dbConnect","summary":"Database connection failed","description":"Temporary. Retry with backoff.","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/400/content/application~1json/examples/dbConnect"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/401/content/application~1json/examples/unauthorized":{"value":{"message":"Authentication error"},"key":"unauthorized","summary":"Expired or missing token","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/401/content/application~1json/examples/unauthorized"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/401/content/application~1json/examples/noRevenueUser":{"value":{"Status":"Error","Result":null,"Message":"Error decoding token"},"key":"noRevenueUser","summary":"User of the OAuth client not found in Zuora Revenue","description":"The OAuth client's Zuora user has no matching Zuora Revenue user. Map the user in Zuora Revenue.","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/401/content/application~1json/examples/noRevenueUser"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/403/content/application~1json/examples/restricted":{"value":{"Message":"You are not authorized to access this endpoint. Please contact Zuora Revenue Support"},"key":"restricted","summary":"API not enabled for the tenant","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/403/content/application~1json/examples/restricted"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/403/content/application~1json/examples/customHeaders":{"value":{"Status":"Error","Result":null,"Message":"Missing/Invalid request headers"},"key":"customHeaders","summary":"Required custom headers missing","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/403/content/application~1json/examples/customHeaders"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/429/content/application~1json/examples/rateLimited":{"value":{"message":"Too many requests"},"key":"rateLimited","summary":"Rate limit exceeded","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/429/content/application~1json/examples/rateLimited"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/500/content/application~1json/examples/dbError":{"value":{"Status":"Error","Result":null,"Message":"Unexpected Error. Please contact Zuora Revenue Support"},"key":"dbError","summary":"Database error","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/500/content/application~1json/examples/dbError"},"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/502/content/application~1json/examples/queryService":{"value":{"Status":"Error","Result":null,"Message":"Query service error. Please contact Zuora Revenue Support"},"key":"queryService","summary":"Query service error","id":"paths/~1api~1integration~1v2~1biviews-status~1{task_id}/delete/responses/502/content/application~1json/examples/queryService"},"paths/~1journal-entries/post/requestBody/content/application~1json/examples/balancedReclass":{"value":{"jeHeader":{"name":"SEP-2026 Revenue Reclass","description":"Reclass deferred revenue for contract RC-1001","bookId":1,"orgId":"101","periodId":202609,"categoryCode":"RECLASS","sobId":1,"functionalCurrency":"USD","exchangeRateType":"User","accountMethod":"Standard","glTransfer":"Yes","approvalCurrency":"USD"},"lines":[{"jeSetNo":1,"accountType":"Contract Liability","accountCode":"2400-100-000","currency":"USD","drAmount":1500,"exchangeRate":1,"gexchangeRate":1,"exchangeRateDate":"2026-09-30","startDate":"2026-09-01","endDate":"2026-09-30","rcId":1001,"soNum":"SO-50012","soLineId":"SO-50012-1","description":"Release deferred revenue","reference1":"TCK-4471"},{"jeSetNo":1,"accountType":"Revenue","accountCode":"4000-100-000","currency":"USD","crAmount":1500,"exchangeRate":1,"gexchangeRate":1,"exchangeRateDate":"2026-09-30","startDate":"2026-09-01","endDate":"2026-09-30","rcId":1001,"soNum":"SO-50012","soLineId":"SO-50012-1","description":"Recognize revenue","reference1":"TCK-4471"}]},"key":"balancedReclass","summary":"Balanced two-line reclass","id":"paths/~1journal-entries/post/requestBody/content/application~1json/examples/balancedReclass"},"paths/~1journal-entries/post/requestBody/content/multipart~1form-data/examples/combinedCsv":{"value":{"lines":"Name,Description,Category Code,Ex Rate Type,Period Name,Reversal Period Name,SOB Name,SOB ID,Functional Currency,Book Id,Org Id,GL Transfer,Rev Rec Type,Account Method,Approval Currency\nSEP-2026 Revenue Reclass,Reclass deferred revenue,RECLASS,User,202609,,,1,USD,1,101,Yes,,Standard,USD\n\nSet No,Account Type,Account Code,Currency,Debit,Credit,Ex Rate Date,Ex Rate,G Ex Rate,Start Date,End Date,RC Id,SO Number,Description\n1,Contract Liability,2400-100-000,USD,1500.00,,2026-09-30,1,1,2026-09-01,2026-09-30,1001,SO-50012,Release deferred revenue\n1,Revenue,4000-100-000,USD,,1500.00,2026-09-30,1,1,2026-09-01,2026-09-30,1001,SO-50012,Recognize revenue\n"},"key":"combinedCsv","summary":"Combined CSV (header + lines in one file)","id":"paths/~1journal-entries/post/requestBody/content/multipart~1form-data/examples/combinedCsv"},"paths/~1journal-entries/post/responses/201/content/application~1json/examples/journalEntryCreated":{"value":{"success":true,"id":10045,"name":"SEP-2026 Revenue Reclass","status":"New","description":"Reclass deferred revenue for contract RC-1001","waterfallStatus":"NEW","jeHeader":{"id":10045,"name":"SEP-2026 Revenue Reclass","description":"Reclass deferred revenue for contract RC-1001","categoryCode":"RECLASS","exchangeRateType":"User","sobId":1,"sobName":"US Primary SOB","functionalCurrency":"USD","periodId":202609,"clientId":1,"orgId":"101","bookId":1,"accountMethod":"Standard","status":"New","approvalCurrency":"USD","glTransfer":"Yes","waterfallStatus":"NEW","createdBy":"jane.doe@example.com","createdDate":"2026-09-28T10:21:04.000+00:00","updatedBy":"jane.doe@example.com","updatedDate":"2026-09-28T10:21:04.000+00:00"}},"key":"journalEntryCreated","summary":"Journal entry created","id":"paths/~1journal-entries/post/responses/201/content/application~1json/examples/journalEntryCreated"},"paths/~1journal-entries/post/responses/400/content/application~1json/examples/missingRequiredFields":{"value":{"success":false,"reasons":[{"code":"MISSING_REQUIRED_FIELD","message":"Missing required fields: categoryCode; line 2, exchangeRateDate; line 2, at least one of drAmount or crAmount is required"}]},"key":"missingRequiredFields","summary":"Missing required fields","description":"One or more mandatory header or line fields are missing. All missing fields are listed in one message.","id":"paths/~1journal-entries/post/responses/400/content/application~1json/examples/missingRequiredFields"},"paths/~1journal-entries/post/responses/400/content/application~1json/examples/invalidValues":{"value":{"success":false,"reasons":[{"code":"INVALID_VALUE","message":"Invalid values: line 1, exchangeRate: must be a number greater than 0; line 1, endDate must be on or after startDate"}]},"key":"invalidValues","summary":"Invalid values","description":"All mandatory fields are present but a value breaks a rule, for example an exchange rate of 0 or an end date before the start date.","id":"paths/~1journal-entries/post/responses/400/content/application~1json/examples/invalidValues"},"paths/~1journal-entries/post/responses/400/content/application~1json/examples/unknownSetOfBooks":{"value":{"success":false,"reasons":[{"code":"INVALID_VALUE","message":"sobId: no set of books found with id 99","field":"sobId"}]},"key":"unknownSetOfBooks","summary":"Unknown Set of Books","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not match any Set of Books in your tenant."},"children":[]}]}]}],"id":"paths/~1journal-entries/post/responses/400/content/application~1json/examples/unknownSetOfBooks"},"paths/~1journal-entries/post/responses/400/content/application~1json/examples/invalidCsv":{"value":{"success":false,"reasons":[{"code":"INVALID_CSV","message":"CSV validation failed: Row 2, Debit: must be non-negative, got '-1500'; Row 3, Ex Rate: not a valid number 'one'"}]},"key":"invalidCsv","summary":"Invalid CSV","description":"(CSV upload) The file is empty, the layout is wrong, a column is duplicated, or a cell cannot be parsed. Every problem is listed.","id":"paths/~1journal-entries/post/responses/400/content/application~1json/examples/invalidCsv"},"paths/~1journal-entries/post/responses/400/content/application~1json/examples/headerSuppliedTwice":{"value":{"success":false,"reasons":[{"code":"CONFLICTING_HEADER","message":"Journal entry header supplied both as the 'jeHeader' part and in the CSV header section; supply only one","field":"jeHeader"}]},"key":"headerSuppliedTwice","summary":"Header supplied twice","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(CSV upload) The CSV contains a header section "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeHeader"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" part was sent."},"children":[]}]}]}],"id":"paths/~1journal-entries/post/responses/400/content/application~1json/examples/headerSuppliedTwice"},"paths/~1journal-entries/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries/post/responses/502/content/application~1json/examples/entryRejectedByJournalEntryProcessing":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: \"Period is not open for the given book and org\""}]},"key":"entryRejectedByJournalEntryProcessing","summary":"Entry rejected by journal entry processing","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The journal entry processing service rejected the entry, for example because the period is closed or soft-frozen, or a value (account code, category, currency) is not valid in your tenant. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reasons[0].code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the processing status and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the detail."},"children":[]}]}]}],"id":"paths/~1journal-entries/post/responses/502/content/application~1json/examples/entryRejectedByJournalEntryProcessing"},"paths/~1journal-entries/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries/get/responses/200/content/application~1json/examples/pageOfJournalEntries":{"value":{"pageNumber":1,"pageSize":20,"totalRecords":2,"result":[{"id":10045,"name":"SEP-2026 Revenue Reclass","description":"Reclass deferred revenue for contract RC-1001","reversalStatus":"","categoryCode":"RECLASS","exRateType":"User","periodId":"SEP-2026","status":"New","reversalPeriodId":"OCT-2026","hashTotal":3000,"sobName":"US Primary SOB","sobId":1,"functionalCurrency":"USD","createdBy":"jane.doe@example.com","createdDate":"2026-09-28 10:21:04","updatedBy":"jane.doe@example.com","updatedDate":"2026-09-28 10:21:04","approverName":null,"bookId":1,"secAtrVal":"101"},{"id":10046,"name":"SEP-2026 Accrual","description":"Reclass deferred revenue for contract RC-1001","reversalStatus":"","categoryCode":"ACCRUAL","exRateType":"User","periodId":"SEP-2026","status":"Validated","reversalPeriodId":"OCT-2026","hashTotal":840,"sobName":"US Primary SOB","sobId":1,"functionalCurrency":"USD","createdBy":"jane.doe@example.com","createdDate":"2026-09-28 10:21:04","updatedBy":"jane.doe@example.com","updatedDate":"2026-09-28 10:21:04","approverName":null,"bookId":1,"secAtrVal":"101"}]},"key":"pageOfJournalEntries","summary":"Page of journal entries","id":"paths/~1journal-entries/get/responses/200/content/application~1json/examples/pageOfJournalEntries"},"paths/~1journal-entries/get/responses/200/content/application~1json/examples/projected":{"value":{"pageNumber":1,"pageSize":20,"totalRecords":2,"result":[{"id":10045,"name":"SEP-2026 Revenue Reclass","status":"New"},{"id":10046,"name":"SEP-2026 Accrual","status":"Validated"}]},"key":"projected","summary":"With `fields=name,status`","id":"paths/~1journal-entries/get/responses/200/content/application~1json/examples/projected"},"paths/~1journal-entries/get/responses/400/content/application~1json/examples/unknownFilterField":{"value":{"success":false,"reasons":[{"code":"INVALID_VALUE","message":"Unknown field 'state'. Allowed fields: approverName, categoryCode, createdBy, createdDate, description, exchangeRateType, functionalCurrency, hashTotal, id, name, periodId, reversalPeriodId, reversalStatus, sobId, sobName, status, updatedBy, updatedDate"}]},"key":"unknownFilterField","summary":"Unknown filter field","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names a field that is not in the allowed list."},"children":[]}]}]}],"id":"paths/~1journal-entries/get/responses/400/content/application~1json/examples/unknownFilterField"},"paths/~1journal-entries/get/responses/400/content/application~1json/examples/unsupportedOperator":{"value":{"success":false,"reasons":[{"code":"INVALID_VALUE","message":"Unsupported filter operator 'CONTAINS' in 'name.CONTAINS:Reclass'"}]},"key":"unsupportedOperator","summary":"Unsupported operator","description":"The filter operator is not one of EQ, NE, LT, GT, LE, GE, SW, IN.","id":"paths/~1journal-entries/get/responses/400/content/application~1json/examples/unsupportedOperator"},"paths/~1journal-entries/get/responses/400/content/application~1json/examples/invalidCursor":{"value":{"success":false,"reasons":[{"code":"INVALID_VALUE","message":"Invalid cursor 'abc': not a valid page reference"}]},"key":"invalidCursor","summary":"Invalid cursor","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cursor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not a number (a value below 1 returns "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid cursor '0': must be a positive page number"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1journal-entries/get/responses/400/content/application~1json/examples/invalidCursor"},"paths/~1journal-entries/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1query/post/requestBody/content/application~1json/examples/openEntries":{"value":{"pageNumber":1,"pageSize":20,"filters":[{"fieldName":"status","operator":"IN","values":["New","Validated"]},{"fieldName":"periodId","operator":"IN","values":["SEP-2026"]}],"ordering":{"fieldName":"createdDate","orderBy":"DESC"}},"key":"openEntries","summary":"New or validated entries posted to SEP-2026","id":"paths/~1journal-entries~1query/post/requestBody/content/application~1json/examples/openEntries"},"paths/~1journal-entries~1query/post/responses/200/content/application~1json/examples/pageOfJournalEntries":{"value":{"pageNumber":1,"pageSize":20,"totalRecords":2,"result":[{"id":10045,"name":"SEP-2026 Revenue Reclass","description":"Reclass deferred revenue for contract RC-1001","reversalStatus":"","categoryCode":"RECLASS","exRateType":"User","periodId":"SEP-2026","status":"New","reversalPeriodId":"OCT-2026","hashTotal":3000,"sobName":"US Primary SOB","sobId":1,"functionalCurrency":"USD","createdBy":"jane.doe@example.com","createdDate":"2026-09-28 10:21:04","updatedBy":"jane.doe@example.com","updatedDate":"2026-09-28 10:21:04","approverName":null,"bookId":1,"secAtrVal":"101"},{"id":10046,"name":"SEP-2026 Accrual","description":"Reclass deferred revenue for contract RC-1001","reversalStatus":"","categoryCode":"ACCRUAL","exRateType":"User","periodId":"SEP-2026","status":"Validated","reversalPeriodId":"OCT-2026","hashTotal":840,"sobName":"US Primary SOB","sobId":1,"functionalCurrency":"USD","createdBy":"jane.doe@example.com","createdDate":"2026-09-28 10:21:04","updatedBy":"jane.doe@example.com","updatedDate":"2026-09-28 10:21:04","approverName":null,"bookId":1,"secAtrVal":"101"}]},"key":"pageOfJournalEntries","summary":"Page of journal entries","id":"paths/~1journal-entries~1query/post/responses/200/content/application~1json/examples/pageOfJournalEntries"},"paths/~1journal-entries~1query/post/responses/400/content/application~1json/examples/unknownProjectionField":{"value":{"success":false,"reasons":[{"code":"INVALID_VALUE","message":"Unknown field 'foo'. Available fields: [id, name, description, ...]"}]},"key":"unknownProjectionField","summary":"Unknown projection field","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A name in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not a property of the list item."},"children":[]}]}]}],"id":"paths/~1journal-entries~1query/post/responses/400/content/application~1json/examples/unknownProjectionField"},"paths/~1journal-entries~1query/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1query/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1query/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1query/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1query/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1query/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1query/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1query/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1query/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1query/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1query/post/responses/502/content/application~1json/examples/invalidFilterFieldOrOperator":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: [no body]"}]},"key":"invalidFilterFieldOrOperator","summary":"Invalid filter field or operator","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body is not one of the supported values, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is empty."},"children":[]}]}]}],"id":"paths/~1journal-entries~1query/post/responses/502/content/application~1json/examples/invalidFilterFieldOrOperator"},"paths/~1journal-entries~1query/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1query/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}/get/responses/200/content/application~1json/examples/journalEntry":{"value":{"success":true,"id":10045,"name":"SEP-2026 Revenue Reclass","status":"New","description":"Reclass deferred revenue for contract RC-1001","waterfallStatus":"NEW","jeHeader":{"id":10045,"name":"SEP-2026 Revenue Reclass","description":"Reclass deferred revenue for contract RC-1001","categoryCode":"RECLASS","exchangeRateType":"User","sobId":1,"sobName":"US Primary SOB","functionalCurrency":"USD","periodId":202609,"periodDisplayValue":"SEP-2026","clientId":1,"orgId":"101","orgName":"US Operations","bookId":1,"bookName":"Primary Book","accountMethod":"Standard","revRecType":"STANDARD","status":"New","jeStatus":"New","approvalCurrency":"USD","glTransfer":"Yes","waterfallStatus":"NEW","jeWaterfallStatus":"NEW","jeTempWaterfallStatus":"NEW","reversalStatus":"","errorCount":0,"errorMessages":[],"createdBy":"jane.doe@example.com","createdDate":"2026-09-28T10:21:04.000+00:00","updatedBy":"jane.doe@example.com","updatedDate":"2026-09-28T10:21:04.000+00:00"}},"key":"journalEntry","summary":"Journal entry","id":"paths/~1journal-entries~1{jeId}/get/responses/200/content/application~1json/examples/journalEntry"},"paths/~1journal-entries~1{jeId}/get/responses/200/content/application~1json/examples/projected":{"value":{"id":10045,"name":"SEP-2026 Revenue Reclass","status":"New","waterfallStatus":"NEW"},"key":"projected","summary":"With `fields=name,status,waterfallStatus`","id":"paths/~1journal-entries~1{jeId}/get/responses/200/content/application~1json/examples/projected"},"paths/~1journal-entries~1{jeId}/get/responses/400/content/application~1json/examples/unknownProjectionField":{"value":{"success":false,"reasons":[{"code":"INVALID_VALUE","message":"Unknown field 'state'. Available fields: [id, name, description, categoryCode, ...]"}]},"key":"unknownProjectionField","summary":"Unknown projection field","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A name in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not a header property."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}/get/responses/400/content/application~1json/examples/unknownProjectionField"},"paths/~1journal-entries~1{jeId}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}/get/responses/500/content/application~1json/examples/journalEntryNotFound":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"journalEntryNotFound","summary":"Journal entry not found","description":"No journal entry with this ID exists, or it belongs to an organization not assigned to your role.","id":"paths/~1journal-entries~1{jeId}/get/responses/500/content/application~1json/examples/journalEntryNotFound"},"paths/~1journal-entries~1{jeId}/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}/patch/requestBody/content/application~1json/examples/renameAndMove":{"value":{"name":"SEP-2026 Revenue Reclass v2","periodId":202609,"description":"Corrected amounts"},"key":"renameAndMove","summary":"Rename and move to another period","id":"paths/~1journal-entries~1{jeId}/patch/requestBody/content/application~1json/examples/renameAndMove"},"paths/~1journal-entries~1{jeId}/patch/requestBody/content/multipart~1form-data/examples/fullFile":{"value":{"lines":"ID,Set No,Account Type,Account Code,Currency,Debit,Credit,Ex Rate Date,Ex Rate,G Ex Rate,Start Date,End Date\n70001,1,Contract Liability,2400-100-000,USD,1200.00,,2026-09-30,1,1,2026-09-01,2026-09-30\n,1,Revenue,4000-100-000,USD,,1200.00,2026-09-30,1,1,2026-09-01,2026-09-30\n"},"key":"fullFile","summary":"Lines-only full file: update line 70001, insert a new line, delete all others","id":"paths/~1journal-entries~1{jeId}/patch/requestBody/content/multipart~1form-data/examples/fullFile"},"paths/~1journal-entries~1{jeId}/patch/responses/200/content/application~1json/examples/journalEntryUpdated":{"value":{"id":10045,"status":"New","waterfallStatus":"IN PROGRESS"},"key":"journalEntryUpdated","summary":"Journal entry updated","id":"paths/~1journal-entries~1{jeId}/patch/responses/200/content/application~1json/examples/journalEntryUpdated"},"paths/~1journal-entries~1{jeId}/patch/responses/400/content/application~1json/examples/invalidCsvOrLineValues":{"value":{"success":false,"reasons":[{"code":"MISSING_REQUIRED_FIELD","message":"Missing required fields: line 2, accountCode"}]},"key":"invalidCsvOrLineValues","summary":"Invalid CSV or line values","description":"(CSV) The file cannot be parsed, has no lines, or an inserted/updated line is missing a mandatory value.","id":"paths/~1journal-entries~1{jeId}/patch/responses/400/content/application~1json/examples/invalidCsvOrLineValues"},"paths/~1journal-entries~1{jeId}/patch/responses/400/content/application~1json/examples/unknownSetOfBooks":{"value":{"success":false,"reasons":[{"code":"INVALID_VALUE","message":"sobId: no set of books found with id 99","field":"sobId"}]},"key":"unknownSetOfBooks","summary":"Unknown Set of Books","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was supplied but does not match a Set of Books."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}/patch/responses/400/content/application~1json/examples/unknownSetOfBooks"},"paths/~1journal-entries~1{jeId}/patch/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}/patch/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}/patch/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}/patch/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}/patch/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}/patch/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}/patch/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}/patch/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}/patch/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}/patch/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}/patch/responses/502/content/application~1json/examples/entryCannotBeEdited":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: \"Not Allowed .Please check the object status and your role\""}]},"key":"entryCannotBeEdited","summary":"Entry cannot be edited","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The entry's status does not allow editing (for example it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or your role cannot edit it."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}/patch/responses/502/content/application~1json/examples/entryCannotBeEdited"},"paths/~1journal-entries~1{jeId}/patch/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}/patch/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}/delete/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}/delete/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}/delete/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}/delete/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}/delete/responses/502/content/application~1json/examples/deleteNotAllowed":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: \"Not Allowed .Please check the object status and your role\""}]},"key":"deleteNotAllowed","summary":"Delete not allowed","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The entry's status (for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approved"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Approval Pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or your role does not allow deletion."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}/delete/responses/502/content/application~1json/examples/deleteNotAllowed"},"paths/~1journal-entries~1{jeId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1copy/post/requestBody/content/application~1json/examples/nextMonth":{"value":{"name":"OCT-2026 Revenue Reclass","periodId":202610},"key":"nextMonth","summary":"Copy into October","id":"paths/~1journal-entries~1{jeId}~1copy/post/requestBody/content/application~1json/examples/nextMonth"},"paths/~1journal-entries~1{jeId}~1copy/post/responses/201/content/application~1json/examples/copyCreated":{"value":{"success":true,"id":10047,"name":"OCT-2026 Revenue Reclass","status":"New","description":"Reclass deferred revenue for contract RC-1001","waterfallStatus":"NEW","jeHeader":{"id":10047,"name":"OCT-2026 Revenue Reclass","description":"Reclass deferred revenue for contract RC-1001","categoryCode":"RECLASS","exchangeRateType":"User","sobId":1,"sobName":"US Primary SOB","functionalCurrency":"USD","periodId":202610,"clientId":1,"orgId":"101","bookId":1,"accountMethod":"Standard","status":"New","approvalCurrency":"USD","glTransfer":"Yes","waterfallStatus":"NEW","createdBy":"jane.doe@example.com","createdDate":"2026-09-28T10:21:04.000+00:00","updatedBy":"jane.doe@example.com","updatedDate":"2026-09-28T10:21:04.000+00:00"}},"key":"copyCreated","summary":"Copy created","id":"paths/~1journal-entries~1{jeId}~1copy/post/responses/201/content/application~1json/examples/copyCreated"},"paths/~1journal-entries~1{jeId}~1copy/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1copy/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1copy/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1copy/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1copy/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1copy/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1copy/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1copy/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1copy/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1copy/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1copy/post/responses/502/content/application~1json/examples/sourceEntryCannotBeCopied":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: [no body]"}]},"key":"sourceEntryCannotBeCopied","summary":"Source entry cannot be copied","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The source entry does not exist or is not visible to you, or the override "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"periodId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not open."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1copy/post/responses/502/content/application~1json/examples/sourceEntryCannotBeCopied"},"paths/~1journal-entries~1{jeId}~1copy/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1copy/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1search~1{jeName}/get/responses/200/content/application~1json/examples/matchingJournalEntriesMayBeEmpty":{"value":[{"id":10045,"name":"SEP-2026 Revenue Reclass","description":"Reclass deferred revenue for contract RC-1001","reversalStatus":"","categoryCode":"RECLASS","exRateType":"User","periodId":"SEP-2026","status":"New","reversalPeriodId":"OCT-2026","hashTotal":3000,"sobName":"US Primary SOB","sobId":1,"functionalCurrency":"USD","createdBy":"jane.doe@example.com","createdDate":"2026-09-28 10:21:04","updatedBy":"jane.doe@example.com","updatedDate":"2026-09-28 10:21:04","approverName":null,"bookId":1,"secAtrVal":"101"}],"key":"matchingJournalEntriesMayBeEmpty","summary":"Matching journal entries (may be empty)","id":"paths/~1journal-entries~1search~1{jeName}/get/responses/200/content/application~1json/examples/matchingJournalEntriesMayBeEmpty"},"paths/~1journal-entries~1search~1{jeName}/get/responses/200/content/application~1json/examples/noMatch":{"value":[],"key":"noMatch","summary":"No matches","id":"paths/~1journal-entries~1search~1{jeName}/get/responses/200/content/application~1json/examples/noMatch"},"paths/~1journal-entries~1search~1{jeName}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1search~1{jeName}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1search~1{jeName}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1search~1{jeName}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1search~1{jeName}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1search~1{jeName}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1search~1{jeName}/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1search~1{jeName}/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1search~1{jeName}/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1search~1{jeName}/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1search~1{jeName}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1search~1{jeName}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/200/content/application~1json/examples/journalEntriesForTheOrganizationAndBook":{"value":[{"id":10045,"name":"SEP-2026 Revenue Reclass","description":"Reclass deferred revenue for contract RC-1001","reversalStatus":"","categoryCode":"RECLASS","exRateType":"User","periodId":"SEP-2026","status":"New","reversalPeriodId":"OCT-2026","hashTotal":3000,"sobName":"US Primary SOB","sobId":1,"functionalCurrency":"USD","createdBy":"jane.doe@example.com","createdDate":"2026-09-28 10:21:04","updatedBy":"jane.doe@example.com","updatedDate":"2026-09-28 10:21:04","approverName":null,"bookId":1,"secAtrVal":"101"},{"id":10046,"name":"SEP-2026 Accrual","description":"Reclass deferred revenue for contract RC-1001","reversalStatus":"","categoryCode":"ACCRUAL","exRateType":"User","periodId":"SEP-2026","status":"Validated","reversalPeriodId":"OCT-2026","hashTotal":840,"sobName":"US Primary SOB","sobId":1,"functionalCurrency":"USD","createdBy":"jane.doe@example.com","createdDate":"2026-09-28 10:21:04","updatedBy":"jane.doe@example.com","updatedDate":"2026-09-28 10:21:04","approverName":null,"bookId":1,"secAtrVal":"101"}],"key":"journalEntriesForTheOrganizationAndBook","summary":"Journal entries for the organization and book","id":"paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/200/content/application~1json/examples/journalEntriesForTheOrganizationAndBook"},"paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/500/content/application~1json/examples/nonNumericBookId":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"nonNumericBookId","summary":"Non-numeric book ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bookId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the path is not an integer."},"children":[]}]}]}],"id":"paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/500/content/application~1json/examples/nonNumericBookId"},"paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1by-org~1{secAtrVal}~1book~1{bookId}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1healthcheck/get/responses/200/content/application~1json/examples/serviceIsAvailable":{"value":{"success":true,"status":"UP","target":"mje-backend"},"key":"serviceIsAvailable","summary":"Service is available","id":"paths/~1journal-entries~1healthcheck/get/responses/200/content/application~1json/examples/serviceIsAvailable"},"paths/~1journal-entries~1healthcheck/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1healthcheck/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1healthcheck/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1healthcheck/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1healthcheck/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1healthcheck/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1healthcheck/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1healthcheck/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1healthcheck/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1healthcheck/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1healthcheck/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1healthcheck/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1lines/get/responses/200/content/application~1json/examples/journalEntryWithAPageOfLines":{"value":{"success":true,"lines":{"pageNumber":1,"pageSize":20,"totalRecords":2,"result":[{"id":70001,"headerId":10045,"clientId":1,"orgId":"101","bookId":1,"rcId":1001,"rcLineId":50001,"currency":"USD","debit":1500,"credit":null,"exchangeRateDate":"2026-09-30T00:00:00.000+00:00","exchangeRate":1,"gexchangeRate":1,"startDate":"2026-09-01T00:00:00.000+00:00","endDate":"2026-09-30T00:00:00.000+00:00","accountType":"Contract Liability","accountCode":"2400-100-000","jeSetNo":1,"soNum":"SO-50012","soLineId":"SO-50012-1","unbillAccounting":"N","description":"Release deferred revenue","errorMessage":null,"reference1":"TCK-4471","createdBy":"jane.doe@example.com","createdDate":"2026-09-28T10:21:04.000+00:00","updatedBy":"jane.doe@example.com","updatedDate":"2026-09-28T10:21:04.000+00:00"},{"id":70002,"headerId":10045,"clientId":1,"orgId":"101","bookId":1,"rcId":1001,"rcLineId":50001,"currency":"USD","debit":null,"credit":1500,"exchangeRateDate":"2026-09-30T00:00:00.000+00:00","exchangeRate":1,"gexchangeRate":1,"startDate":"2026-09-01T00:00:00.000+00:00","endDate":"2026-09-30T00:00:00.000+00:00","accountType":"Revenue","accountCode":"4000-100-000","jeSetNo":1,"soNum":"SO-50012","soLineId":"SO-50012-1","unbillAccounting":"N","description":"Recognize revenue","errorMessage":null,"reference1":"TCK-4471","createdBy":"jane.doe@example.com","createdDate":"2026-09-28T10:21:04.000+00:00","updatedBy":"jane.doe@example.com","updatedDate":"2026-09-28T10:21:04.000+00:00"}]}},"key":"journalEntryWithAPageOfLines","summary":"Journal entry with a page of lines","id":"paths/~1journal-entries~1{jeId}~1lines/get/responses/200/content/application~1json/examples/journalEntryWithAPageOfLines"},"paths/~1journal-entries~1{jeId}~1lines/get/responses/200/content/application~1json/examples/projected":{"value":{"pageNumber":1,"pageSize":20,"totalRecords":2,"result":[{"id":70001,"accountCode":"2400-100-000","debit":1500,"credit":null},{"id":70002,"accountCode":"4000-100-000","debit":null,"credit":1500}]},"key":"projected","summary":"With `fields=accountCode,debit,credit` (returns the page directly)","id":"paths/~1journal-entries~1{jeId}~1lines/get/responses/200/content/application~1json/examples/projected"},"paths/~1journal-entries~1{jeId}~1lines/get/responses/400/content/application~1json/examples/unknownFilterField":{"value":{"success":false,"reasons":[{"code":"INVALID_VALUE","message":"Unknown field 'amount'. Allowed fields: accountCode, accountType, bookId, comments, ..."}]},"key":"unknownFilterField","summary":"Unknown filter field","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names a field that is not allowed for lines."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines/get/responses/400/content/application~1json/examples/unknownFilterField"},"paths/~1journal-entries~1{jeId}~1lines/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1lines/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1lines/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1lines/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1lines/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1lines/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1lines/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1lines/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/502/content/application~1json/examples/lineCannotBeDeleted":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: \"Not Allowed .Please check the object status and your role\""}]},"key":"lineCannotBeDeleted","summary":"Line cannot be deleted","description":"The entry is no longer editable or your role cannot edit it.","id":"paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/502/content/application~1json/examples/lineCannotBeDeleted"},"paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1lines~1{lineId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1lines~1copy/post/requestBody/content/application~1json/examples/toOtherEntry":{"value":{"targetJeId":10046,"lineIds":[70001,70002]},"key":"toOtherEntry","summary":"Copy two lines to entry 10046","id":"paths/~1journal-entries~1{jeId}~1lines~1copy/post/requestBody/content/application~1json/examples/toOtherEntry"},"paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/200/content/application~1json/examples/copiedLines":{"value":[{"id":70101,"headerId":10046,"clientId":1,"orgId":"101","bookId":1,"rcId":1001,"rcLineId":50001,"currency":"USD","debit":1500,"credit":null,"exchangeRateDate":"2026-09-30T00:00:00.000+00:00","exchangeRate":1,"gexchangeRate":1,"startDate":"2026-09-01T00:00:00.000+00:00","endDate":"2026-09-30T00:00:00.000+00:00","accountType":"Contract Liability","accountCode":"2400-100-000","jeSetNo":1,"soNum":"SO-50012","soLineId":"SO-50012-1","unbillAccounting":"N","description":"Release deferred revenue","errorMessage":null,"reference1":"TCK-4471","createdBy":"jane.doe@example.com","createdDate":"2026-09-28T10:21:04.000+00:00","updatedBy":"jane.doe@example.com","updatedDate":"2026-09-28T10:21:04.000+00:00","createPeriodId":"202609"},{"id":70102,"headerId":10046,"clientId":1,"orgId":"101","bookId":1,"rcId":1001,"rcLineId":50001,"currency":"USD","debit":null,"credit":1500,"exchangeRateDate":"2026-09-30T00:00:00.000+00:00","exchangeRate":1,"gexchangeRate":1,"startDate":"2026-09-01T00:00:00.000+00:00","endDate":"2026-09-30T00:00:00.000+00:00","accountType":"Revenue","accountCode":"4000-100-000","jeSetNo":1,"soNum":"SO-50012","soLineId":"SO-50012-1","unbillAccounting":"N","description":"Recognize revenue","errorMessage":null,"reference1":"TCK-4471","createdBy":"jane.doe@example.com","createdDate":"2026-09-28T10:21:04.000+00:00","updatedBy":"jane.doe@example.com","updatedDate":"2026-09-28T10:21:04.000+00:00","createPeriodId":"202609"}],"key":"copiedLines","summary":"Copied lines","id":"paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/200/content/application~1json/examples/copiedLines"},"paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/502/content/application~1json/examples/targetEntryNotEditable":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: \"Not Allowed .Please check the object status and your role\""}]},"key":"targetEntryNotEditable","summary":"Target entry not editable","description":"The target entry is not editable or the line IDs do not exist.","id":"paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/502/content/application~1json/examples/targetEntryNotEditable"},"paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1lines~1copy/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/200/content/application~1json/examples/matchingLinesMayBeEmpty":{"value":[{"id":70001,"headerId":10045,"clientId":1,"orgId":"101","bookId":1,"rcId":1001,"rcLineId":50001,"currency":"USD","debit":1500,"credit":null,"exchangeRateDate":"2026-09-30T00:00:00.000+00:00","exchangeRate":1,"gexchangeRate":1,"startDate":"2026-09-01T00:00:00.000+00:00","endDate":"2026-09-30T00:00:00.000+00:00","accountType":"Contract Liability","accountCode":"2400-100-000","jeSetNo":1,"soNum":"SO-50012","soLineId":"SO-50012-1","unbillAccounting":"N","description":"Release deferred revenue","errorMessage":null,"reference1":"TCK-4471","createdBy":"jane.doe@example.com","createdDate":"2026-09-28T10:21:04.000+00:00","updatedBy":"jane.doe@example.com","updatedDate":"2026-09-28T10:21:04.000+00:00"},{"id":70002,"headerId":10045,"clientId":1,"orgId":"101","bookId":1,"rcId":1001,"rcLineId":50001,"currency":"USD","debit":null,"credit":1500,"exchangeRateDate":"2026-09-30T00:00:00.000+00:00","exchangeRate":1,"gexchangeRate":1,"startDate":"2026-09-01T00:00:00.000+00:00","endDate":"2026-09-30T00:00:00.000+00:00","accountType":"Revenue","accountCode":"4000-100-000","jeSetNo":1,"soNum":"SO-50012","soLineId":"SO-50012-1","unbillAccounting":"N","description":"Recognize revenue","errorMessage":null,"reference1":"TCK-4471","createdBy":"jane.doe@example.com","createdDate":"2026-09-28T10:21:04.000+00:00","updatedBy":"jane.doe@example.com","updatedDate":"2026-09-28T10:21:04.000+00:00"}],"key":"matchingLinesMayBeEmpty","summary":"Matching lines (may be empty)","id":"paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/200/content/application~1json/examples/matchingLinesMayBeEmpty"},"paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/200/content/application~1json/examples/noMatch":{"value":[],"key":"noMatch","summary":"No matches","id":"paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/200/content/application~1json/examples/noMatch"},"paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1lines~1search~1{soNumber}/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1schedules/get/responses/200/content/application~1json/examples/journalEntryWithAPageOfSchedules":{"value":{"success":true,"schedules":{"pageNumber":1,"pageSize":20,"totalRecords":2,"result":[{"periodName":"SEP-2026","accountType":"Contract Liability","acountCode":"2400-100-000","currencyCode":"USD","drAmount":1500,"crAmount":0,"funcDrAmount":1500,"funcCrAmount":0,"rcurrDrAmount":1500,"rcurrCrAmount":0,"schdRcId":1001,"interfaceFlag":"N"},{"periodName":"SEP-2026","accountType":"Revenue","acountCode":"4000-100-000","currencyCode":"USD","drAmount":0,"crAmount":1500,"funcDrAmount":0,"funcCrAmount":1500,"rcurrDrAmount":0,"rcurrCrAmount":1500,"schdRcId":1001,"interfaceFlag":"N"}]}},"key":"journalEntryWithAPageOfSchedules","summary":"Journal entry with a page of schedules","id":"paths/~1journal-entries~1{jeId}~1schedules/get/responses/200/content/application~1json/examples/journalEntryWithAPageOfSchedules"},"paths/~1journal-entries~1{jeId}~1schedules/get/responses/400/content/application~1json/examples/unknownFilterField":{"value":{"success":false,"reasons":[{"code":"INVALID_VALUE","message":"Unknown field 'period'. Allowed fields: accountCode, accountType, acountCode, crAmount, ..."}]},"key":"unknownFilterField","summary":"Unknown filter field","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names a field that is not allowed for schedules."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1schedules/get/responses/400/content/application~1json/examples/unknownFilterField"},"paths/~1journal-entries~1{jeId}~1schedules/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1schedules/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1schedules/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1schedules/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1schedules/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1schedules/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1schedules/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1schedules/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1schedules/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1schedules/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1schedules/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1schedules/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/200/content/application~1json/examples/pageOfWaterfallEntries":{"value":{"pageNumber":1,"pageSize":20,"totalRecords":1,"result":[{"jeSetNo":"1","soNumber":"SO-50012","soLineId":"SO-50012-1","accountCode":"4000-100-000","jeAmount":1500,"startDate":"2026-09-01T00:00:00.000+00:00","endDate":"2026-11-30T00:00:00.000+00:00","accountType":"Revenue","entries":{"SEP-2026":"500.00","OCT-2026":"500.00","NOV-2026":"500.00"}}]},"key":"pageOfWaterfallEntries","summary":"Page of waterfall entries","id":"paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/200/content/application~1json/examples/pageOfWaterfallEntries"},"paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/400/content/application~1json/examples/unknownFilterField":{"value":{"success":false,"reasons":[{"code":"INVALID_VALUE","message":"Unknown field 'period'. Allowed fields: accountCode, accountType, endDate, jeAmount, jeSetNo, soLineId, soNumber, startDate"}]},"key":"unknownFilterField","summary":"Unknown filter field","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names a field that is not allowed for waterfall entries."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/400/content/application~1json/examples/unknownFilterField"},"paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1waterfall-entries/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/200/content/application~1json/examples/waterfallStatus":{"value":{"id":10045,"waterfallStatus":"SUCCESS"},"key":"waterfallStatus","summary":"Waterfall status","id":"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/200/content/application~1json/examples/waterfallStatus"},"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/200/content/application~1json/examples/inProgress":{"value":{"id":10045,"waterfallStatus":"IN PROGRESS"},"key":"inProgress","summary":"Still generating","id":"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/200/content/application~1json/examples/inProgress"},"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/500/content/application~1json/examples/nonNumericId":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"nonNumericId","summary":"Non-numeric ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not an integer."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/500/content/application~1json/examples/nonNumericId"},"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1waterfall-status/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/200/content/application~1json/examples/waterfallGenerationReTriggered":{"value":{"id":10045,"waterfallStatus":"IN PROGRESS"},"key":"waterfallGenerationReTriggered","summary":"Waterfall generation re-triggered","id":"paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/200/content/application~1json/examples/waterfallGenerationReTriggered"},"paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/502/content/application~1json/examples/retryNotAllowed":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: \"Waterfall Retry not allowed as the job status is NOT in Error. Please check\""}]},"key":"retryNotAllowed","summary":"Retry not allowed","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"waterfallStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/502/content/application~1json/examples/retryNotAllowed"},"paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1waterfall-retry/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1submit/post/requestBody/content/application~1json/examples/withComment":{"value":{"comment":"Ready for September close review"},"key":"withComment","summary":"Submit with a comment","id":"paths/~1journal-entries~1{jeId}~1submit/post/requestBody/content/application~1json/examples/withComment"},"paths/~1journal-entries~1{jeId}~1submit/post/responses/200/content/application~1json/examples/entrySubmitted":{"value":{"success":true,"status":"Approval Pending","results":[{"id":"10045","success":true,"message":"10045 is Submitted Successfully"}]},"key":"entrySubmitted","summary":"Entry submitted","id":"paths/~1journal-entries~1{jeId}~1submit/post/responses/200/content/application~1json/examples/entrySubmitted"},"paths/~1journal-entries~1{jeId}~1submit/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1submit/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1submit/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1submit/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1submit/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1submit/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1submit/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1submit/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1submit/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1submit/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/entryHasValidationErrors":{"value":{"success":false,"reasons":[{"code":"400 BAD_REQUEST","message":"400 Bad Request: \"{\"header\":{},\"jeline\":{\"70002\":\"Invalid account code\"}}\""}]},"key":"entryHasValidationErrors","summary":"Entry has validation errors","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more lines have validation errors, the entry is already submitted or approved, or your role cannot submit it. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains the details returned by journal entry processing."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/entryHasValidationErrors"},"paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/noApprovalRule":{"value":{"success":false,"reasons":[{"code":"403 FORBIDDEN","message":"403 Forbidden: \"{\"header\":{\"10045\":\"Approval Rule not Defined\"}}\""}]},"key":"noApprovalRule","summary":"No approval rule","description":"No approval rule matches the entry, so it cannot enter the approval workflow. Ask your administrator to configure an approval rule.","id":"paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/noApprovalRule"},"paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1submit/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1approve/post/requestBody/content/application~1json/examples/example":{"value":{"jeIds":[10045,10046],"comment":"Approved for September close","bookId":1},"key":"example","summary":"Approve journal entries","id":"paths/~1journal-entries~1approve/post/requestBody/content/application~1json/examples/example"},"paths/~1journal-entries~1approve/post/responses/200/content/application~1json/examples/allEntriesApproved":{"value":{"success":true,"status":"Approved","results":[{"success":true,"message":"Journal entry 10045 approved successfully"},{"success":true,"message":"Journal entry 10046 approved successfully"}]},"key":"allEntriesApproved","summary":"All entries approved","id":"paths/~1journal-entries~1approve/post/responses/200/content/application~1json/examples/allEntriesApproved"},"paths/~1journal-entries~1approve/post/responses/200/content/application~1json/examples/allFailed":{"value":{"success":false,"status":"Approval Pending","results":[{"success":false,"code":"BUSINESS_RULE_VIOLATION","message":"Journal entry 10046 failed to approve."}]},"key":"allFailed","summary":"Every entry was refused (still HTTP 200)","id":"paths/~1journal-entries~1approve/post/responses/200/content/application~1json/examples/allFailed"},"paths/~1journal-entries~1approve/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed":{"value":{"success":false,"status":"Approved","results":[{"success":true,"message":"Journal entry 10045 approved successfully"},{"success":false,"code":"BUSINESS_RULE_VIOLATION","message":"Journal entry 10046 failed to approve."}]},"key":"someEntriesSucceededAndSomeFailed","summary":"Some entries succeeded and some failed","id":"paths/~1journal-entries~1approve/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"},"paths/~1journal-entries~1approve/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1approve/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1approve/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1approve/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1approve/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1approve/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1approve/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1approve/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1approve/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1approve/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1approve/post/responses/502/content/application~1json/examples/actionRejected":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: \"Not Allowed .Please check the object status and your role\""}]},"key":"actionRejected","summary":"Action rejected","description":"The journal entry processing service refused the whole request, for example because the entries are in a status that does not allow this action.","id":"paths/~1journal-entries~1approve/post/responses/502/content/application~1json/examples/actionRejected"},"paths/~1journal-entries~1approve/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1approve/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1reject/post/requestBody/content/application~1json/examples/example":{"value":{"jeIds":[10046],"comment":"Account code is wrong; please correct line 2"},"key":"example","summary":"Reject journal entries","id":"paths/~1journal-entries~1reject/post/requestBody/content/application~1json/examples/example"},"paths/~1journal-entries~1reject/post/responses/200/content/application~1json/examples/allEntriesRejected":{"value":{"success":true,"status":"Rejected","results":[{"success":true,"message":"Journal entry 10045 rejected successfully"},{"success":true,"message":"Journal entry 10046 rejected successfully"}]},"key":"allEntriesRejected","summary":"All entries rejected","id":"paths/~1journal-entries~1reject/post/responses/200/content/application~1json/examples/allEntriesRejected"},"paths/~1journal-entries~1reject/post/responses/200/content/application~1json/examples/allFailed":{"value":{"success":false,"status":"Approval Pending","results":[{"success":false,"code":"BUSINESS_RULE_VIOLATION","message":"Journal entry 10046 failed to reject."}]},"key":"allFailed","summary":"Every entry was refused (still HTTP 200)","id":"paths/~1journal-entries~1reject/post/responses/200/content/application~1json/examples/allFailed"},"paths/~1journal-entries~1reject/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed":{"value":{"success":false,"status":"Rejected","results":[{"success":true,"message":"Journal entry 10045 rejected successfully"},{"success":false,"code":"BUSINESS_RULE_VIOLATION","message":"Journal entry 10046 failed to reject."}]},"key":"someEntriesSucceededAndSomeFailed","summary":"Some entries succeeded and some failed","id":"paths/~1journal-entries~1reject/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"},"paths/~1journal-entries~1reject/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1reject/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1reject/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1reject/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1reject/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1reject/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1reject/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1reject/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1reject/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1reject/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1reject/post/responses/502/content/application~1json/examples/actionRejected":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: \"Not Allowed .Please check the object status and your role\""}]},"key":"actionRejected","summary":"Action rejected","description":"The journal entry processing service refused the whole request, for example because the entries are in a status that does not allow this action.","id":"paths/~1journal-entries~1reject/post/responses/502/content/application~1json/examples/actionRejected"},"paths/~1journal-entries~1reject/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1reject/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1recall/post/requestBody/content/application~1json/examples/example":{"value":{"jeIds":[10045],"comment":"Recalling to fix amount"},"key":"example","summary":"Recall journal entries","id":"paths/~1journal-entries~1recall/post/requestBody/content/application~1json/examples/example"},"paths/~1journal-entries~1recall/post/responses/200/content/application~1json/examples/allEntriesRecalled":{"value":{"success":true,"results":[{"success":true,"message":"Journal entry 10045 recalled successfully"},{"success":true,"message":"Journal entry 10046 recalled successfully"}]},"key":"allEntriesRecalled","summary":"All entries recalled","id":"paths/~1journal-entries~1recall/post/responses/200/content/application~1json/examples/allEntriesRecalled"},"paths/~1journal-entries~1recall/post/responses/200/content/application~1json/examples/allFailed":{"value":{"success":false,"results":[{"success":false,"code":"BUSINESS_RULE_VIOLATION","message":"Journal entry 10046 failed to recall."}]},"key":"allFailed","summary":"Every entry was refused (still HTTP 200)","id":"paths/~1journal-entries~1recall/post/responses/200/content/application~1json/examples/allFailed"},"paths/~1journal-entries~1recall/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed":{"value":{"success":false,"results":[{"success":true,"message":"Journal entry 10045 recalled successfully"},{"success":false,"code":"BUSINESS_RULE_VIOLATION","message":"Journal entry 10046 failed to recall."}]},"key":"someEntriesSucceededAndSomeFailed","summary":"Some entries succeeded and some failed","id":"paths/~1journal-entries~1recall/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"},"paths/~1journal-entries~1recall/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1recall/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1recall/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1recall/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1recall/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1recall/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1recall/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1recall/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1recall/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1recall/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1recall/post/responses/502/content/application~1json/examples/actionRejected":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: \"Not Allowed .Please check the object status and your role\""}]},"key":"actionRejected","summary":"Action rejected","description":"The journal entry processing service refused the whole request, for example because the entries are in a status that does not allow this action.","id":"paths/~1journal-entries~1recall/post/responses/502/content/application~1json/examples/actionRejected"},"paths/~1journal-entries~1recall/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1recall/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1reverse/post/requestBody/content/application~1json/examples/example":{"value":{"jeIds":[10045],"reversalPeriod":202610,"comment":"Reverse September reclass"},"key":"example","summary":"Reverse a journal entry","id":"paths/~1journal-entries~1reverse/post/requestBody/content/application~1json/examples/example"},"paths/~1journal-entries~1reverse/post/responses/200/content/application~1json/examples/entryReversed":{"value":{"success":true,"results":[{"success":true,"message":"Journal entry 10045 reversed successfully"}]},"key":"entryReversed","summary":"Entry reversed","id":"paths/~1journal-entries~1reverse/post/responses/200/content/application~1json/examples/entryReversed"},"paths/~1journal-entries~1reverse/post/responses/200/content/application~1json/examples/allFailed":{"value":{"success":false,"results":[{"success":false,"code":"BUSINESS_RULE_VIOLATION","message":"Journal entry 10046 failed to reverse."}]},"key":"allFailed","summary":"Every entry was refused (still HTTP 200)","id":"paths/~1journal-entries~1reverse/post/responses/200/content/application~1json/examples/allFailed"},"paths/~1journal-entries~1reverse/post/responses/400/content/application~1json/examples/moreThanOneEntry":{"value":{"success":false,"reasons":[{"code":"INVALID_VALUE","message":"jeIds: reverse accepts exactly one journal entry id","field":"jeIds"}]},"key":"moreThanOneEntry","summary":"More than one entry","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" does not contain exactly one ID."},"children":[]}]}]}],"id":"paths/~1journal-entries~1reverse/post/responses/400/content/application~1json/examples/moreThanOneEntry"},"paths/~1journal-entries~1reverse/post/responses/400/content/application~1json/examples/reversalPeriodMissing":{"value":{"success":false,"reasons":[{"code":"MISSING_REQUIRED_FIELD","message":"Missing required fields: reversalPeriod","field":"reversalPeriod"}]},"key":"reversalPeriodMissing","summary":"Reversal period missing","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversalPeriod"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was not supplied."},"children":[]}]}]}],"id":"paths/~1journal-entries~1reverse/post/responses/400/content/application~1json/examples/reversalPeriodMissing"},"paths/~1journal-entries~1reverse/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1reverse/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1reverse/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1reverse/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1reverse/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1reverse/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1reverse/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1reverse/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1reverse/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1reverse/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1reverse/post/responses/502/content/application~1json/examples/actionRejected":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: \"Not Allowed .Please check the object status and your role\""}]},"key":"actionRejected","summary":"Action rejected","description":"The journal entry processing service refused the whole request, for example because the entries are in a status that does not allow this action.","id":"paths/~1journal-entries~1reverse/post/responses/502/content/application~1json/examples/actionRejected"},"paths/~1journal-entries~1reverse/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1reverse/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1bulk-delete/post/requestBody/content/application~1json/examples/example":{"value":{"jeIds":[10045,10046]},"key":"example","summary":"Delete several journal entries","id":"paths/~1journal-entries~1bulk-delete/post/requestBody/content/application~1json/examples/example"},"paths/~1journal-entries~1bulk-delete/post/responses/200/content/application~1json/examples/allEntriesDeleted":{"value":{"success":true,"results":[{"success":true,"message":"Journal entry 10045 deleted successfully"},{"success":true,"message":"Journal entry 10046 deleted successfully"}]},"key":"allEntriesDeleted","summary":"All entries deleted","id":"paths/~1journal-entries~1bulk-delete/post/responses/200/content/application~1json/examples/allEntriesDeleted"},"paths/~1journal-entries~1bulk-delete/post/responses/200/content/application~1json/examples/allFailed":{"value":{"success":false,"results":[{"success":false,"code":"BUSINESS_RULE_VIOLATION","message":"Journal entry 10046 failed to delete."}]},"key":"allFailed","summary":"Every entry was refused (still HTTP 200)","id":"paths/~1journal-entries~1bulk-delete/post/responses/200/content/application~1json/examples/allFailed"},"paths/~1journal-entries~1bulk-delete/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed":{"value":{"success":false,"results":[{"success":true,"message":"Journal entry 10045 deleted successfully"},{"success":false,"code":"BUSINESS_RULE_VIOLATION","message":"Journal entry 10046 failed to delete."}]},"key":"someEntriesSucceededAndSomeFailed","summary":"Some entries succeeded and some failed","id":"paths/~1journal-entries~1bulk-delete/post/responses/207/content/application~1json/examples/someEntriesSucceededAndSomeFailed"},"paths/~1journal-entries~1bulk-delete/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1bulk-delete/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1bulk-delete/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1bulk-delete/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1bulk-delete/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1bulk-delete/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1bulk-delete/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1bulk-delete/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1bulk-delete/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1bulk-delete/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1bulk-delete/post/responses/502/content/application~1json/examples/actionRejected":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: \"Not Allowed .Please check the object status and your role\""}]},"key":"actionRejected","summary":"Action rejected","description":"The journal entry processing service refused the whole request, for example because the entries are in a status that does not allow this action.","id":"paths/~1journal-entries~1bulk-delete/post/responses/502/content/application~1json/examples/actionRejected"},"paths/~1journal-entries~1bulk-delete/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1bulk-delete/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1privileges/post/requestBody/content/application~1json/examples/single":{"value":{"jeIds":[10045],"bookId":1},"key":"single","summary":"One entry","id":"paths/~1journal-entries~1privileges/post/requestBody/content/application~1json/examples/single"},"paths/~1journal-entries~1privileges/post/responses/200/content/application~1json/examples/allowedActions":{"value":{"submitAllowed":true,"approveAllowed":false,"rejectAllowed":false,"recallAllowed":false,"deleteAllowed":true,"updateAllowed":true,"revertAllowed":false},"key":"allowedActions","summary":"Allowed actions","id":"paths/~1journal-entries~1privileges/post/responses/200/content/application~1json/examples/allowedActions"},"paths/~1journal-entries~1privileges/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1privileges/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1privileges/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1privileges/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1privileges/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1privileges/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1privileges/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1privileges/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1privileges/post/responses/500/content/application~1json/examples/malformedBody":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"malformedBody","summary":"Malformed body","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The body is not valid JSON or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not an array of integers."},"children":[]}]}]}],"id":"paths/~1journal-entries~1privileges/post/responses/500/content/application~1json/examples/malformedBody"},"paths/~1journal-entries~1privileges/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1privileges/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1privileges/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1privileges/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1events/get/responses/200/content/application~1json/examples/auditEventsOldestFirst":{"value":[{"id":900001,"action":"SAVE","headerId":10045,"bookId":1,"clientId":1,"createdPeriodId":202609,"createdBy":"jane.doe@example.com","createdDate":"2026-09-28 10:21:04","secAtrValue":"101"},{"id":900002,"action":"SUBMIT","headerId":10045,"comments":"Ready for September close review","bookId":1,"clientId":1,"createdPeriodId":202609,"createdBy":"jane.doe@example.com","createdDate":"2026-09-28 11:02:44","secAtrValue":"101"}],"key":"auditEventsOldestFirst","summary":"Audit events (oldest first)","id":"paths/~1journal-entries~1{jeId}~1events/get/responses/200/content/application~1json/examples/auditEventsOldestFirst"},"paths/~1journal-entries~1{jeId}~1events/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1events/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1events/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1events/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1events/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1events/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1events/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1events/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1events/get/responses/500/content/application~1json/examples/nonNumericId":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"nonNumericId","summary":"Non-numeric ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not an integer."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1events/get/responses/500/content/application~1json/examples/nonNumericId"},"paths/~1journal-entries~1{jeId}~1events/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1events/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1events/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1events/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/200/content/application~1json/examples/validationStatus":{"value":{"id":10045,"validationStatus":"Validated"},"key":"validationStatus","summary":"Validation status","id":"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/200/content/application~1json/examples/validationStatus"},"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/200/content/application~1json/examples/errors":{"value":{"id":10045,"validationStatus":"Error"},"key":"errors","summary":"Validation found errors","id":"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/200/content/application~1json/examples/errors"},"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/500/content/application~1json/examples/nonNumericId":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"nonNumericId","summary":"Non-numeric ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not an integer."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/500/content/application~1json/examples/nonNumericId"},"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1validation-status/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1metadata/get/responses/200/content/application~1json/examples/referenceData":{"value":{"createDate":"2026-10-07","bookId":[{"id":1,"name":"Primary Book"}],"orgId":[{"id":101,"name":"US Operations"}],"categoryId":[{"key":"ACCRUAL","value":"Accrual"},{"key":"RECLASS","value":"Reclassification"}],"exchangeRates":[{"key":"User","value":"User"},{"key":"Corporate","value":"Corporate"}],"approvalCurrency":["USD","EUR"],"sobName":["US Primary SOB"],"functionalCurrency":["USD"],"glTransfer":["YES","NO"],"accountingMethod":[{"key":"Standard","value":"Standard"}],"accountTypes":[{"key":"Revenue","value":"Revenue"},{"key":"Contract Liability","value":"Contract Liability"}],"accountingSegments":[{"key":"Company","value":"Company"},{"key":"Department","value":"Department"},{"key":"Account","value":"Account"}],"vcTypes":[{"key":"Rebate","value":"Rebate"}],"costTypes":[{"key":"Commission","value":"Commission"}]},"key":"referenceData","summary":"Reference data","id":"paths/~1journal-entries~1metadata/get/responses/200/content/application~1json/examples/referenceData"},"paths/~1journal-entries~1metadata/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1metadata/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1metadata/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1metadata/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1metadata/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1metadata/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1metadata/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1metadata/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1metadata/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1metadata/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1metadata/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1metadata/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1metadata~1periods/get/responses/200/content/application~1json/examples/periods":{"value":{"postingPeriod":[{"id":202609,"name":"SEP-2026"},{"id":202610,"name":"OCT-2026"}],"reversalPeriod":[{"id":202610,"name":"OCT-2026"},{"id":202611,"name":"NOV-2026"}]},"key":"periods","summary":"Periods","id":"paths/~1journal-entries~1metadata~1periods/get/responses/200/content/application~1json/examples/periods"},"paths/~1journal-entries~1metadata~1periods/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1metadata~1periods/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1metadata~1periods/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1metadata~1periods/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1metadata~1periods/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1metadata~1periods/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1metadata~1periods/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1metadata~1periods/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1metadata~1periods/get/responses/500/content/application~1json/examples/bookidMissing":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"bookidMissing","summary":"bookId missing","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The required "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bookId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is missing or not an integer."},"children":[]}]}]}],"id":"paths/~1journal-entries~1metadata~1periods/get/responses/500/content/application~1json/examples/bookidMissing"},"paths/~1journal-entries~1metadata~1periods/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1metadata~1periods/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1metadata~1periods/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1metadata~1periods/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1configurations/get/responses/200/content/application~1json/examples/fieldConfiguration":{"value":{"fields":[{"code":"REFERENCE1","value":"Ticket Number","sequence":29},{"code":"REFERENCE2","value":"Source System","sequence":30}]},"key":"fieldConfiguration","summary":"Field configuration","id":"paths/~1journal-entries~1configurations/get/responses/200/content/application~1json/examples/fieldConfiguration"},"paths/~1journal-entries~1configurations/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1configurations/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1configurations/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1configurations/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1configurations/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1configurations/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1configurations/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1configurations/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1configurations/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1configurations/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1configurations/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1configurations/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1current-period/get/responses/200/content/application~1json/examples/currentOpenPeriod":{"value":{"periodId":202610,"periodDisplayValue":"OCT-2026"},"key":"currentOpenPeriod","summary":"Current open period","id":"paths/~1journal-entries~1current-period/get/responses/200/content/application~1json/examples/currentOpenPeriod"},"paths/~1journal-entries~1current-period/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1current-period/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1current-period/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1current-period/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1current-period/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1current-period/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1current-period/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1current-period/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1current-period/get/responses/500/content/application~1json/examples/bookidMissing":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"bookidMissing","summary":"bookId missing","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The required "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bookId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is missing or not an integer."},"children":[]}]}]}],"id":"paths/~1journal-entries~1current-period/get/responses/500/content/application~1json/examples/bookidMissing"},"paths/~1journal-entries~1current-period/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1current-period/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1current-period/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1current-period/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1currencies/get/responses/200/content/application~1json/examples/currencyCodes":{"value":["USD","EUR","GBP","JPY"],"key":"currencyCodes","summary":"Currency codes","id":"paths/~1journal-entries~1currencies/get/responses/200/content/application~1json/examples/currencyCodes"},"paths/~1journal-entries~1currencies/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1currencies/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1currencies/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1currencies/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1currencies/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1currencies/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1currencies/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1currencies/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1currencies/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1currencies/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1currencies/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1currencies/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1functional-currencies/get/responses/200/content/application~1json/examples/functionalCurrencies":{"value":["USD"],"key":"functionalCurrencies","summary":"Functional currencies","id":"paths/~1journal-entries~1functional-currencies/get/responses/200/content/application~1json/examples/functionalCurrencies"},"paths/~1journal-entries~1functional-currencies/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1functional-currencies/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1functional-currencies/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1functional-currencies/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1functional-currencies/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1functional-currencies/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1functional-currencies/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1functional-currencies/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1functional-currencies/get/responses/500/content/application~1json/examples/sobnameMissing":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"sobnameMissing","summary":"sobName missing","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The required "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sobName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is missing."},"children":[]}]}]}],"id":"paths/~1journal-entries~1functional-currencies/get/responses/500/content/application~1json/examples/sobnameMissing"},"paths/~1journal-entries~1functional-currencies/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1functional-currencies/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1functional-currencies/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1functional-currencies/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1summary/get/responses/200/content/application~1json/examples/totalsByCurrencyType":{"value":[{"currencyType":"Transaction","currency":"USD","drAmt":"1500.00","crAmt":"1500.00","netAmt":"0.00"},{"currencyType":"Functional","currency":"USD","drAmt":"1500.00","crAmt":"1500.00","netAmt":"0.00"},{"currencyType":"Reporting","currency":"USD","drAmt":"1500.00","crAmt":"1500.00","netAmt":"0.00"}],"key":"totalsByCurrencyType","summary":"Totals by currency type","id":"paths/~1journal-entries~1{jeId}~1summary/get/responses/200/content/application~1json/examples/totalsByCurrencyType"},"paths/~1journal-entries~1{jeId}~1summary/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1summary/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1summary/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1summary/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1summary/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1summary/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1summary/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1summary/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1summary/get/responses/500/content/application~1json/examples/nonNumericId":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"nonNumericId","summary":"Non-numeric ID","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not an integer."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1summary/get/responses/500/content/application~1json/examples/nonNumericId"},"paths/~1journal-entries~1{jeId}~1summary/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1summary/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1summary/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1summary/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1soft-freeze-check/get/responses/200/content/application~1json/examples/softFreezeState":{"value":[{"bookId":1,"secAtrVal":"101","softFreezeApplied":false},{"bookId":1,"secAtrVal":"102","softFreezeApplied":true}],"key":"softFreezeState","summary":"Soft-freeze state","id":"paths/~1journal-entries~1soft-freeze-check/get/responses/200/content/application~1json/examples/softFreezeState"},"paths/~1journal-entries~1soft-freeze-check/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1soft-freeze-check/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1soft-freeze-check/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1soft-freeze-check/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1soft-freeze-check/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1soft-freeze-check/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1soft-freeze-check/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1soft-freeze-check/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1soft-freeze-check/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1soft-freeze-check/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1soft-freeze-check/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1soft-freeze-check/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1role/get/responses/200/content/application~1json/examples/accessLevel":{"value":{"role":"FULL_ACCESS"},"key":"accessLevel","summary":"Access level","id":"paths/~1journal-entries~1role/get/responses/200/content/application~1json/examples/accessLevel"},"paths/~1journal-entries~1role/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1role/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1role/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1role/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1role/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1role/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1role/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1role/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1role/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1role/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1role/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1role/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1describe/get/responses/200/content/application~1json/examples/columnCatalog":{"value":{"objects":{"jeLine":{"columns":[{"name":"JE_SET_NO","label":"JE Set No","dataType":"id","sequence":1},{"name":"DR_ACTIVITY_TYPE","label":"Dr Activity Type","dataType":"string","sequence":2},{"name":"DR_SEGMENTS","label":"Account Code","dataType":"string","sequence":3},{"name":"REFERENCE1","label":"Ticket Number","dataType":"string","sequence":29}]}}},"key":"columnCatalog","summary":"Column catalog","id":"paths/~1journal-entries~1describe/get/responses/200/content/application~1json/examples/columnCatalog"},"paths/~1journal-entries~1describe/get/responses/400/content/application~1json/examples/unknownObject":{"value":{"success":false,"reasons":[{"code":"INVALID_VALUE","message":"The parameter 'object' has an invalid value: 'jeHeader'. Expected one of: jeHead, jeLine, rcSchedule.","field":"object"}]},"key":"unknownObject","summary":"Unknown object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"object"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeHead"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jeLine"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rcSchedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"id":"paths/~1journal-entries~1describe/get/responses/400/content/application~1json/examples/unknownObject"},"paths/~1journal-entries~1describe/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1describe/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1describe/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1describe/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1describe/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1describe/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1describe/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1describe/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1describe/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1describe/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1describe/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1describe/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1rc-redirection/get/responses/200/content/application~1json/examples/revenueContractFound":{"value":{"rcId":1001,"retCode":"0","errMsg":null},"key":"revenueContractFound","summary":"Revenue contract found","id":"paths/~1journal-entries~1rc-redirection/get/responses/200/content/application~1json/examples/revenueContractFound"},"paths/~1journal-entries~1rc-redirection/get/responses/200/content/application~1json/examples/notFound":{"value":{"rcId":null,"retCode":"1","errMsg":"Invalid Id"},"key":"notFound","summary":"No contract found (still HTTP 200)","id":"paths/~1journal-entries~1rc-redirection/get/responses/200/content/application~1json/examples/notFound"},"paths/~1journal-entries~1rc-redirection/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1rc-redirection/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1rc-redirection/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1rc-redirection/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1rc-redirection/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1rc-redirection/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1rc-redirection/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1rc-redirection/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1rc-redirection/get/responses/500/content/application~1json/examples/invalidType":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"invalidType","summary":"Invalid type","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SO"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LINE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or a required parameter is missing."},"children":[]}]}]}],"id":"paths/~1journal-entries~1rc-redirection/get/responses/500/content/application~1json/examples/invalidType"},"paths/~1journal-entries~1rc-redirection/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1rc-redirection/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1rc-redirection/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1rc-redirection/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1attachments/post/requestBody/content/multipart~1form-data/examples/file":{"value":{"file":"(binary content of support.xlsx)"},"key":"file","summary":"Upload a workbook","id":"paths/~1journal-entries~1{jeId}~1attachments/post/requestBody/content/multipart~1form-data/examples/file"},"paths/~1journal-entries~1{jeId}~1attachments/post/responses/200/content/application~1json/examples/attachmentUploaded":{"value":{"status":"success","message":"Notes/Attachments are successfully uploaded"},"key":"attachmentUploaded","summary":"Attachment uploaded","id":"paths/~1journal-entries~1{jeId}~1attachments/post/responses/200/content/application~1json/examples/attachmentUploaded"},"paths/~1journal-entries~1{jeId}~1attachments/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1attachments/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1attachments/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1attachments/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1attachments/post/responses/413/content/application~1json/examples/fileTooLarge":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":413,"error":"Payload Too Large","message":"Maximum upload size exceeded","path":"/journal-entries/10045/attachments"},"key":"fileTooLarge","summary":"File too large","description":"The file exceeds the 100 MB upload limit.","id":"paths/~1journal-entries~1{jeId}~1attachments/post/responses/413/content/application~1json/examples/fileTooLarge"},"paths/~1journal-entries~1{jeId}~1attachments/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1attachments/post/responses/500/content/application~1json/examples/filePartOrBookidMissing":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"filePartOrBookidMissing","summary":"File part or bookId missing","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" part or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bookId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is missing."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments/post/responses/500/content/application~1json/examples/filePartOrBookidMissing"},"paths/~1journal-entries~1{jeId}~1attachments/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1attachments/post/responses/502/content/application~1json/examples/executableFileRejected":{"value":{"success":false,"reasons":[{"code":"400 BAD_REQUEST","message":"400 Bad Request: \"{\"status\":\"failure\",\"message\":\"Executable files are not allowed\"}\""}]},"key":"executableFileRejected","summary":"Executable file rejected","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Executable files ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".exe"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".bat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".sh"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".msi"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":".cmd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") cannot be attached."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments/post/responses/502/content/application~1json/examples/executableFileRejected"},"paths/~1journal-entries~1{jeId}~1attachments/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1attachments/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1attachments/get/responses/200/content/application~1json/examples/attachmentsMayBeEmpty":{"value":[{"id":501,"fileName":"support.xlsx","comments":"Supporting calculation","addLink":null,"jeId":10045,"bookId":1,"contentType":"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","fileSize":18432,"crtdBy":"jane.doe@example.com","crtdDt":"2026-09-28T11:05:00"}],"key":"attachmentsMayBeEmpty","summary":"Attachments (may be empty)","id":"paths/~1journal-entries~1{jeId}~1attachments/get/responses/200/content/application~1json/examples/attachmentsMayBeEmpty"},"paths/~1journal-entries~1{jeId}~1attachments/get/responses/200/content/application~1json/examples/none":{"value":[],"key":"none","summary":"No attachments","id":"paths/~1journal-entries~1{jeId}~1attachments/get/responses/200/content/application~1json/examples/none"},"paths/~1journal-entries~1{jeId}~1attachments/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1attachments/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1attachments/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1attachments/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1attachments/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1attachments/get/responses/500/content/application~1json/examples/bookidMissing":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"bookidMissing","summary":"bookId missing","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The required "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bookId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter is missing or not an integer."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments/get/responses/500/content/application~1json/examples/bookidMissing"},"paths/~1journal-entries~1{jeId}~1attachments/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1attachments/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1attachments/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/502/content/application~1json/examples/invalidAttachmentId":{"value":{"success":false,"reasons":[{"code":"400 BAD_REQUEST","message":"400 Bad Request: \"{\"status\":\"failure\",\"message\":\"The provided attachment ID is invalid\"}\""}]},"key":"invalidAttachmentId","summary":"Invalid attachment ID","description":"The attachment does not exist.","id":"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/502/content/application~1json/examples/invalidAttachmentId"},"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}/delete/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/200/content/application~1json/examples/presignedDownloadUrlCloudStoredFiles":{"value":{"url":"https://zr-attachments.s3.amazonaws.com/t1/je/10045/501?X-Amz-Expires=300&X-Amz-Signature=..."},"key":"presignedDownloadUrlCloudStoredFiles","summary":"Presigned download URL (cloud-stored files)","id":"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/200/content/application~1json/examples/presignedDownloadUrlCloudStoredFiles"},"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/502/content/application~1json/examples/fileNotFound":{"value":{"success":false,"reasons":[{"code":"400 BAD_REQUEST","message":"400 Bad Request: \"{\"status\":\"failure\",\"message\":\"The requested file could not be found\"}\""}]},"key":"fileNotFound","summary":"File not found","description":"The attachment does not exist or has no file (for example a note-only entry).","id":"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/502/content/application~1json/examples/fileNotFound"},"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1attachments~1{attachmentId}~1download/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1template/get/responses/200/content/text~1csv/example":{"value":"Name,Description,Category Code,Ex Rate Type,Period Name,Reversal Period Name,SOB Name,SOB ID,Functional Currency,Book Id,Org Id,GL Transfer,Rev Rec Type,Account Method,Approval Currency\n\n\nSet No,Account Type,Account Code,Currency,Debit,Credit,Ex Rate Date,Functional Ex Rate,Global Ex Rate,Start Date,End Date,So Line Id,Unbill Flag,Description,Rc Id,Rc Line Id,SO Number,Type Name,Cost Or Vc Type,Reference 1,...,Reference 15,Comments\n","id":"paths/~1journal-entries~1template/get/responses/200/content/text~1csv/example"},"paths/~1journal-entries~1template/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1template/get/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1template/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1template/get/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1template/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. GET operations require read access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1template/get/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1template/get/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1template/get/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1template/get/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1template/get/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1template/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1template/get/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1export/post/requestBody/content/application~1json/examples/all":{"value":{"pageNumber":1,"pageSize":40,"filters":[]},"key":"all","summary":"Export all rows","id":"paths/~1journal-entries~1export/post/requestBody/content/application~1json/examples/all"},"paths/~1journal-entries~1export/post/responses/200/content/text~1csv/example":{"value":"Name,ID,Description,Reversal Status,Category Code,Ex Rate Type,Period Name,Status,Reversal Period Name,Hash Total,SOB Name,SOB ID,Functional Currency,Created By,Creation Date,Last Updated By,Last Updated Date,Approver Name\nSEP-2026 Revenue Reclass,10045,Reclass deferred revenue,,RECLASS,User,SEP-2026,New,OCT-2026,3000,US Primary SOB,1,USD,jane.doe@example.com,2026-09-28,jane.doe@example.com,2026-09-28,\n","id":"paths/~1journal-entries~1export/post/responses/200/content/text~1csv/example"},"paths/~1journal-entries~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1export/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1export/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1export/post/responses/500/content/application~1json/examples/missingBody":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"missingBody","summary":"Missing body","description":"The request body is missing or not valid JSON.","id":"paths/~1journal-entries~1export/post/responses/500/content/application~1json/examples/missingBody"},"paths/~1journal-entries~1export/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1export/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1export/post/responses/502/content/application~1json/examples/invalidFilter":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: [no body]"}]},"key":"invalidFilter","summary":"Invalid filter","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body is not supported, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is empty."},"children":[]}]}]}],"id":"paths/~1journal-entries~1export/post/responses/502/content/application~1json/examples/invalidFilter"},"paths/~1journal-entries~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1lines~1export/post/requestBody/content/application~1json/examples/all":{"value":{"pageNumber":1,"pageSize":40,"filters":[]},"key":"all","summary":"Export all rows","id":"paths/~1journal-entries~1{jeId}~1lines~1export/post/requestBody/content/application~1json/examples/all"},"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/200/content/text~1csv/example":{"value":"Set No,Account Type,Account Code,Currency,Debit,Credit,Ex Rate Date,Functional Ex Rate,Global Ex Rate,Start Date,End Date,...,Error Message,Org Id,Book Id,Created By\n1,Contract Liability,2400-100-000,USD,1500,,2026-09-30,1,1,2026-09-01,2026-09-30,...,,101,1,jane.doe@example.com\n1,Revenue,4000-100-000,USD,,1500,2026-09-30,1,1,2026-09-01,2026-09-30,...,,101,1,jane.doe@example.com\n","id":"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/200/content/text~1csv/example"},"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/500/content/application~1json/examples/missingBody":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"missingBody","summary":"Missing body","description":"The request body is missing or not valid JSON.","id":"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/500/content/application~1json/examples/missingBody"},"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/502/content/application~1json/examples/invalidFilter":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: [no body]"}]},"key":"invalidFilter","summary":"Invalid filter","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body is not supported, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is empty."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/502/content/application~1json/examples/invalidFilter"},"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1lines~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1schedules~1export/post/requestBody/content/application~1json/examples/all":{"value":{"pageNumber":1,"pageSize":40,"filters":[]},"key":"all","summary":"Export all rows","id":"paths/~1journal-entries~1{jeId}~1schedules~1export/post/requestBody/content/application~1json/examples/all"},"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/200/content/text~1csv/example":{"value":"Period,Account Type,Account Code,Currency,Debit Amount,Credit Amount\nSEP-2026,Revenue,4000-100-000,USD,0,1500\n","id":"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/200/content/text~1csv/example"},"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/500/content/application~1json/examples/missingBody":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"missingBody","summary":"Missing body","description":"The request body is missing or not valid JSON.","id":"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/500/content/application~1json/examples/missingBody"},"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/502/content/application~1json/examples/invalidFilter":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: [no body]"}]},"key":"invalidFilter","summary":"Invalid filter","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body is not supported, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is empty."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/502/content/application~1json/examples/invalidFilter"},"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1schedules~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/requestBody/content/application~1json/examples/all":{"value":{"pageNumber":1,"pageSize":40,"filters":[]},"key":"all","summary":"Export all rows","id":"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/requestBody/content/application~1json/examples/all"},"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/200/content/text~1csv/example":{"value":"Set No,SO Number,SO Line ID,Account Code,JE Amount,Start Date,End Date,Account Type,SEP-2026,OCT-2026,NOV-2026\n1,SO-50012,SO-50012-1,4000-100-000,1500,2026-09-01,2026-11-30,Revenue,500.00,500.00,500.00\n","id":"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/200/content/text~1csv/example"},"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken":{"value":{"message":"Authentication error"},"key":"missingOrExpiredAccessToken","summary":"Missing or expired access token","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header is missing, malformed or the bearer token has expired. The request is rejected by the Zuora API gateway before it reaches the service. Obtain a new token and retry."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/401/content/application~1json/examples/missingOrExpiredAccessToken"},"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"This version of MJE cannot use APIs. Please contact support to upgrade to New MJE UI.","path":"/journal-entries"},"key":"manualJournalEntryApisNotEnabled","summary":"Manual Journal Entry APIs not enabled","description":"Your tenant is not on the New MJE experience, which is a prerequisite for these APIs. Contact Zuora Support to enable it.","id":"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/403/content/application~1json/examples/manualJournalEntryApisNotEnabled"},"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess":{"value":{"timestamp":"2026-10-07T10:15:30.123+00:00","status":403,"error":"Forbidden","message":"No message available","path":"/journal-entries"},"key":"roleLacksManualJournalAccess","summary":"Role lacks Manual Journal access","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user behind the token does not have "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"edit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" access to the Manual Journal function in Zuora Revenue role setup. All POST, PATCH and DELETE operations (including POST searches and exports) require edit access."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/403/content/application~1json/examples/roleLacksManualJournalAccess"},"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/429/content/application~1json/examples/tooManyRequests":{"value":{"message":"Too many requests"},"key":"tooManyRequests","summary":"Too many requests","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You exceeded the API rate limit for your tenant. Wait and retry using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header when present."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/429/content/application~1json/examples/tooManyRequests"},"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/500/content/application~1json/examples/missingBody":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"missingBody","summary":"Missing body","description":"The request body is missing or not valid JSON.","id":"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/500/content/application~1json/examples/missingBody"},"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/500/content/application~1json/examples/unexpectedError":{"value":{"success":false,"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"unexpectedError","summary":"Unexpected error","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpected error occurred, for example a malformed JSON body, a non-numeric path ID, a missing required query parameter, or the requested entry could not be loaded. Check the request; if it is valid, retry with backoff and contact Zuora Support with the response "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/500/content/application~1json/examples/unexpectedError"},"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/502/content/application~1json/examples/invalidFilter":{"value":{"success":false,"reasons":[{"code":"500 INTERNAL_SERVER_ERROR","message":"500 Internal Server Error: [no body]"}]},"key":"invalidFilter","summary":"Invalid filter","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fieldName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body is not supported, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is empty."},"children":[]}]}]}],"id":"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/502/content/application~1json/examples/invalidFilter"},"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable":{"value":{"success":false,"reasons":[{"code":"UPSTREAM_SERVICE_ERROR","message":"MJE backend is not reachable: I/O error on POST request"}]},"key":"journalEntryServiceUnavailable","summary":"Journal entry service unavailable","description":"The journal entry processing service could not be reached. Retry with exponential backoff.","id":"paths/~1journal-entries~1{jeId}~1waterfall-entries~1export/post/responses/502/content/application~1json/examples/journalEntryServiceUnavailable"},"paths/~1contracts~1list/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":111442,"bookId":1,"indicators":{"allocationEligible":"Y","multiCurrency":"N"},"totalCarveAmount":"1250.00"}],"page":{"number":1,"size":20,"totalElements":57,"totalPages":3,"first":true,"last":false}},"key":"firstPage","summary":"First page of contracts","id":"paths/~1contracts~1list/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1contracts~1list/get/responses/200/content/application~1json/examples/empty":{"value":{"data":[],"page":{"number":1,"size":20,"totalElements":0,"totalPages":0,"first":true,"last":true}},"key":"empty","summary":"No contract matched","id":"paths/~1contracts~1list/get/responses/200/content/application~1json/examples/empty"},"paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unknownFilter":{"value":{"error":"Cannot filter by: customerName. Supported filter fields: id"},"key":"unknownFilter","summary":"Unsupported filter field","id":"paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unknownFilter"},"paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unknownSort":{"value":{"error":"Cannot sort by: bookId. Supported sort fields: id"},"key":"unknownSort","summary":"Unsupported sort field","id":"paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unknownSort"},"paths/~1contracts~1list/get/responses/400/content/application~1json/examples/pageSizeTooLarge":{"value":{"error":"Page size exceeds maximum. Maximum allowed: 100, requested: 500"},"key":"pageSizeTooLarge","summary":"Page size above 100","id":"paths/~1contracts~1list/get/responses/400/content/application~1json/examples/pageSizeTooLarge"},"paths/~1contracts~1list/get/responses/400/content/application~1json/examples/pageSizeNotPositive":{"value":{"error":"Page size must be positive. Requested: 0"},"key":"pageSizeNotPositive","summary":"Page size zero or negative","id":"paths/~1contracts~1list/get/responses/400/content/application~1json/examples/pageSizeNotPositive"},"paths/~1contracts~1list/get/responses/400/content/application~1json/examples/negativePage":{"value":{"error":"Page number must be non-negative. Requested: -1"},"key":"negativePage","summary":"Negative page number","id":"paths/~1contracts~1list/get/responses/400/content/application~1json/examples/negativePage"},"paths/~1contracts~1list/get/responses/400/content/application~1json/examples/invalidPage":{"value":{"error":"Invalid value 'x' for parameter 'page': expected a valid Integer"},"key":"invalidPage","summary":"Non-numeric page","id":"paths/~1contracts~1list/get/responses/400/content/application~1json/examples/invalidPage"},"paths/~1contracts~1list/get/responses/400/content/application~1json/examples/tooManyFilters":{"value":{"error":"Too many filters. Maximum allowed: 5, provided: 6"},"key":"tooManyFilters","summary":"More than five filters","id":"paths/~1contracts~1list/get/responses/400/content/application~1json/examples/tooManyFilters"},"paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unsupportedOperator":{"value":{"error":"Unsupported operator: 'between'. Supported operators: eq, ne, gt, gte, lt, lte, like, in, nin"},"key":"unsupportedOperator","summary":"Unsupported filter operator","id":"paths/~1contracts~1list/get/responses/400/content/application~1json/examples/unsupportedOperator"},"paths/~1contracts~1list/get/responses/500/content/application~1json/examples/internalError":{"value":{"error":"Internal server error"},"key":"internalError","summary":"Internal server error","id":"paths/~1contracts~1list/get/responses/500/content/application~1json/examples/internalError"},"paths/~1contracts~1{rcId}/get/responses/200/content/application~1json/examples/contract":{"value":{"id":111442,"bookId":1,"indicators":{"allocationEligible":"Y","multiCurrency":"N"},"totalCarveAmount":"1250.00"},"key":"contract","summary":"Revenue contract","id":"paths/~1contracts~1{rcId}/get/responses/200/content/application~1json/examples/contract"},"paths/~1contracts~1{rcId}/get/responses/400/content/application~1json/examples/invalidRcId":{"value":{"error":"Invalid value 'abc' for parameter 'rcId': expected a valid Long"},"key":"invalidRcId","summary":"Non-numeric rcId","id":"paths/~1contracts~1{rcId}/get/responses/400/content/application~1json/examples/invalidRcId"},"paths/~1contracts~1{rcId}/get/responses/404/content/application~1json/examples/notFound":{"value":{"error":"Revenue contract 999999 not found"},"key":"notFound","summary":"Revenue contract not found","id":"paths/~1contracts~1{rcId}/get/responses/404/content/application~1json/examples/notFound"},"paths/~1contracts~1{rcId}/get/responses/500/content/application~1json/examples/internalError":{"value":{"error":"Internal server error"},"key":"internalError","summary":"Internal server error","id":"paths/~1contracts~1{rcId}/get/responses/500/content/application~1json/examples/internalError"},"paths/~1contracts~1{rcId}~1lines/get/responses/200/content/application~1json/examples/firstPage":{"value":{"data":[{"id":85922,"rcId":111442,"indicators":{"allocationEligible":"Y"},"stringAttributes":{"atr1":"EMEA","atr2":null},"numberAttributes":{"num1":"12.50","num2":null},"dateAttributes":{"date1":"2026-01-31","date2":null},"rcLineOtrAttributes":{"rpcNum":"C-00012345"}}],"page":{"number":1,"size":20,"totalElements":1,"totalPages":1,"first":true,"last":true}},"key":"firstPage","summary":"Lines of a contract","id":"paths/~1contracts~1{rcId}~1lines/get/responses/200/content/application~1json/examples/firstPage"},"paths/~1contracts~1{rcId}~1lines/get/responses/200/content/application~1json/examples/empty":{"value":{"data":[],"page":{"number":1,"size":20,"totalElements":0,"totalPages":0,"first":true,"last":true}},"key":"empty","summary":"No line matched","id":"paths/~1contracts~1{rcId}~1lines/get/responses/200/content/application~1json/examples/empty"},"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unknownFilter":{"value":{"error":"Cannot filter by: lineId. Supported filter fields: id, rcId, rcPobId, batchId, chargeNumber"},"key":"unknownFilter","summary":"Unsupported filter field","id":"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unknownFilter"},"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unknownSort":{"value":{"error":"Cannot sort by: amount. Supported sort fields: id, rcId, rcPobId, batchId, chargeNumber"},"key":"unknownSort","summary":"Unsupported sort field","id":"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unknownSort"},"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/invalidRcId":{"value":{"error":"Invalid value 'abc' for parameter 'rcId': expected a valid Long"},"key":"invalidRcId","summary":"Non-numeric rcId","id":"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/invalidRcId"},"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/pageSizeTooLarge":{"value":{"error":"Page size exceeds maximum. Maximum allowed: 100, requested: 500"},"key":"pageSizeTooLarge","summary":"Page size above 100","id":"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/pageSizeTooLarge"},"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/pageSizeNotPositive":{"value":{"error":"Page size must be positive. Requested: 0"},"key":"pageSizeNotPositive","summary":"Page size zero or negative","id":"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/pageSizeNotPositive"},"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/negativePage":{"value":{"error":"Page number must be non-negative. Requested: -1"},"key":"negativePage","summary":"Negative page number","id":"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/negativePage"},"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/invalidPage":{"value":{"error":"Invalid value 'x' for parameter 'page': expected a valid Integer"},"key":"invalidPage","summary":"Non-numeric page","id":"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/invalidPage"},"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/tooManyFilters":{"value":{"error":"Too many filters. Maximum allowed: 5, provided: 6"},"key":"tooManyFilters","summary":"More than five filters","id":"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/tooManyFilters"},"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unsupportedOperator":{"value":{"error":"Unsupported operator: 'between'. Supported operators: eq, ne, gt, gte, lt, lte, like, in, nin"},"key":"unsupportedOperator","summary":"Unsupported filter operator","id":"paths/~1contracts~1{rcId}~1lines/get/responses/400/content/application~1json/examples/unsupportedOperator"},"paths/~1contracts~1{rcId}~1lines/get/responses/500/content/application~1json/examples/internalError":{"value":{"error":"Internal server error"},"key":"internalError","summary":"Internal server error","id":"paths/~1contracts~1{rcId}~1lines/get/responses/500/content/application~1json/examples/internalError"},"paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/200/content/application~1json/examples/line":{"value":{"id":85922,"rcId":111442,"indicators":{"allocationEligible":"Y"},"stringAttributes":{"atr1":"EMEA","atr2":null},"numberAttributes":{"num1":"12.50","num2":null},"dateAttributes":{"date1":"2026-01-31","date2":null},"rcLineOtrAttributes":{"rpcNum":"C-00012345"}},"key":"line","summary":"Revenue contract line","id":"paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/200/content/application~1json/examples/line"},"paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/400/content/application~1json/examples/invalidRcId":{"value":{"error":"Invalid value 'abc' for parameter 'rcId': expected a valid Long"},"key":"invalidRcId","summary":"Non-numeric rcId","id":"paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/400/content/application~1json/examples/invalidRcId"},"paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/400/content/application~1json/examples/invalidLineId":{"value":{"error":"Invalid value 'x1' for parameter 'lineId': expected a valid Long"},"key":"invalidLineId","summary":"Non-numeric lineId","id":"paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/400/content/application~1json/examples/invalidLineId"},"paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/404/content/application~1json/examples/notFound":{"value":{"error":"Revenue contract line 85999 not found"},"key":"notFound","summary":"Revenue contract line not found","id":"paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/404/content/application~1json/examples/notFound"},"paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/500/content/application~1json/examples/internalError":{"value":{"error":"Internal server error"},"key":"internalError","summary":"Internal server error","id":"paths/~1contracts~1{rcId}~1lines~1{lineId}/get/responses/500/content/application~1json/examples/internalError"},"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/200/content/application~1json/examples/lines":{"value":{"data":[{"id":85922,"rcId":111442,"indicators":{"allocationEligible":"Y"},"stringAttributes":{"atr1":"EMEA","atr2":null},"numberAttributes":{"num1":"12.50","num2":null},"dateAttributes":{"date1":"2026-01-31","date2":null},"rcLineOtrAttributes":{"rpcNum":"C-00012345"}}],"page":{"number":1,"size":20,"totalElements":1,"totalPages":1,"first":true,"last":true}},"key":"lines","summary":"Lines for the charge","id":"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/200/content/application~1json/examples/lines"},"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/200/content/application~1json/examples/empty":{"value":{"data":[],"page":{"number":1,"size":20,"totalElements":0,"totalPages":0,"first":true,"last":true}},"key":"empty","summary":"No line for the charge","id":"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/200/content/application~1json/examples/empty"},"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/unknownFilter":{"value":{"error":"Cannot filter by: sku. Supported filter fields: id, rcId, rcPobId, batchId, chargeNumber"},"key":"unknownFilter","summary":"Unsupported filter field","id":"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/unknownFilter"},"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/pageSizeTooLarge":{"value":{"error":"Page size exceeds maximum. Maximum allowed: 100, requested: 500"},"key":"pageSizeTooLarge","summary":"Page size above 100","id":"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/pageSizeTooLarge"},"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/pageSizeNotPositive":{"value":{"error":"Page size must be positive. Requested: 0"},"key":"pageSizeNotPositive","summary":"Page size zero or negative","id":"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/pageSizeNotPositive"},"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/negativePage":{"value":{"error":"Page number must be non-negative. Requested: -1"},"key":"negativePage","summary":"Negative page number","id":"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/negativePage"},"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/invalidPage":{"value":{"error":"Invalid value 'x' for parameter 'page': expected a valid Integer"},"key":"invalidPage","summary":"Non-numeric page","id":"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/invalidPage"},"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/tooManyFilters":{"value":{"error":"Too many filters. Maximum allowed: 5, provided: 6"},"key":"tooManyFilters","summary":"More than five filters","id":"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/tooManyFilters"},"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/unsupportedOperator":{"value":{"error":"Unsupported operator: 'between'. Supported operators: eq, ne, gt, gte, lt, lte, like, in, nin"},"key":"unsupportedOperator","summary":"Unsupported filter operator","id":"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/400/content/application~1json/examples/unsupportedOperator"},"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/500/content/application~1json/examples/internalError":{"value":{"error":"Internal server error"},"key":"internalError","summary":"Internal server error","id":"paths/~1contracts~1{rcId}~1lines~1charge-number~1{chargeNumber}/get/responses/500/content/application~1json/examples/internalError"},"paths/~1contracts~1charges/get/responses/200/content/application~1json/examples/byCharge":{"value":{"data":[{"id":85922,"rcId":111442,"indicators":{"allocationEligible":"Y"},"stringAttributes":{"atr1":"EMEA","atr2":null},"numberAttributes":{"num1":"12.50","num2":null},"dateAttributes":{"date1":"2026-01-31","date2":null},"rcLineOtrAttributes":{"rpcNum":"C-00012345"}}],"page":{"number":1,"size":20,"totalElements":1,"totalPages":1,"first":true,"last":true}},"key":"byCharge","summary":"Lines for charge C-00012345","id":"paths/~1contracts~1charges/get/responses/200/content/application~1json/examples/byCharge"},"paths/~1contracts~1charges/get/responses/200/content/application~1json/examples/empty":{"value":{"data":[],"page":{"number":1,"size":20,"totalElements":0,"totalPages":0,"first":true,"last":true}},"key":"empty","summary":"No charge line matched","id":"paths/~1contracts~1charges/get/responses/200/content/application~1json/examples/empty"},"paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/unknownFilter":{"value":{"error":"Cannot filter by: subscription. Supported filter fields: id, rcId, rcPobId, batchId, chargeNumber"},"key":"unknownFilter","summary":"Unsupported filter field","id":"paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/unknownFilter"},"paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/pageSizeTooLarge":{"value":{"error":"Page size exceeds maximum. Maximum allowed: 100, requested: 500"},"key":"pageSizeTooLarge","summary":"Page size above 100","id":"paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/pageSizeTooLarge"},"paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/pageSizeNotPositive":{"value":{"error":"Page size must be positive. Requested: 0"},"key":"pageSizeNotPositive","summary":"Page size zero or negative","id":"paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/pageSizeNotPositive"},"paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/negativePage":{"value":{"error":"Page number must be non-negative. Requested: -1"},"key":"negativePage","summary":"Negative page number","id":"paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/negativePage"},"paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/invalidPage":{"value":{"error":"Invalid value 'x' for parameter 'page': expected a valid Integer"},"key":"invalidPage","summary":"Non-numeric page","id":"paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/invalidPage"},"paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/tooManyFilters":{"value":{"error":"Too many filters. Maximum allowed: 5, provided: 6"},"key":"tooManyFilters","summary":"More than five filters","id":"paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/tooManyFilters"},"paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/unsupportedOperator":{"value":{"error":"Unsupported operator: 'between'. Supported operators: eq, ne, gt, gte, lt, lte, like, in, nin"},"key":"unsupportedOperator","summary":"Unsupported filter operator","id":"paths/~1contracts~1charges/get/responses/400/content/application~1json/examples/unsupportedOperator"},"paths/~1contracts~1charges/get/responses/500/content/application~1json/examples/internalError":{"value":{"error":"Internal server error"},"key":"internalError","summary":"Internal server error","id":"paths/~1contracts~1charges/get/responses/500/content/application~1json/examples/internalError"},"paths/~1revenue-holds/get/responses/200/content/application~1json/examples/rcHolds":{"value":{"data":[{"id":20,"name":"Pending Acceptance","description":"Hold revenue until customer acceptance is received","startDate":"2026-01-01","endDate":null,"eventId":1003,"expiryFieldName":null,"expiryNumberType":null,"expiryDuration":null,"flags":{"enabled":"Y","allowManualRelease":"Y","allowManualApply":"Y","holdType":"Revenue Hold","holdLevel":"RC","scheduleType":"Both"},"createdPeriodId":202601,"clientId":1,"createdBy":"jsmith","createdDate":"2026-01-05","updatedBy":"jsmith","updatedDate":"2026-02-10"}],"page":{"number":1,"size":20,"totalElements":1,"totalPages":1,"first":true,"last":true}},"key":"rcHolds","summary":"RC-level holds","id":"paths/~1revenue-holds/get/responses/200/content/application~1json/examples/rcHolds"},"paths/~1revenue-holds/get/responses/200/content/application~1json/examples/empty":{"value":{"data":[],"page":{"number":1,"size":20,"totalElements":0,"totalPages":0,"first":true,"last":true}},"key":"empty","summary":"No hold matched","id":"paths/~1revenue-holds/get/responses/200/content/application~1json/examples/empty"},"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/invalidHoldLevel":{"value":{"error":"Unknown holdLevel value: 'ORDER'. Allowed: RC, POB, LINE, CHARGE"},"key":"invalidHoldLevel","summary":"Unknown hold level","id":"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/invalidHoldLevel"},"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/blankHoldLevel":{"value":{"error":"Unknown holdLevel value: ''. Allowed: RC, POB, LINE, CHARGE"},"key":"blankHoldLevel","summary":"Blank hold level","id":"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/blankHoldLevel"},"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/unknownFilter":{"value":{"error":"Cannot filter by: type. Supported filter fields: id, name, startDate, endDate, holdLevel"},"key":"unknownFilter","summary":"Unsupported filter field","id":"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/unknownFilter"},"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/pageSizeTooLarge":{"value":{"error":"Page size exceeds maximum. Maximum allowed: 100, requested: 500"},"key":"pageSizeTooLarge","summary":"Page size above 100","id":"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/pageSizeTooLarge"},"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/pageSizeNotPositive":{"value":{"error":"Page size must be positive. Requested: 0"},"key":"pageSizeNotPositive","summary":"Page size zero or negative","id":"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/pageSizeNotPositive"},"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/negativePage":{"value":{"error":"Page number must be non-negative. Requested: -1"},"key":"negativePage","summary":"Negative page number","id":"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/negativePage"},"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/invalidPage":{"value":{"error":"Invalid value 'x' for parameter 'page': expected a valid Integer"},"key":"invalidPage","summary":"Non-numeric page","id":"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/invalidPage"},"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/tooManyFilters":{"value":{"error":"Too many filters. Maximum allowed: 5, provided: 6"},"key":"tooManyFilters","summary":"More than five filters","id":"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/tooManyFilters"},"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/unsupportedOperator":{"value":{"error":"Unsupported operator: 'between'. Supported operators: eq, ne, gt, gte, lt, lte, like, in, nin"},"key":"unsupportedOperator","summary":"Unsupported filter operator","id":"paths/~1revenue-holds/get/responses/400/content/application~1json/examples/unsupportedOperator"},"paths/~1revenue-holds/get/responses/500/content/application~1json/examples/internalError":{"value":{"error":"Internal server error"},"key":"internalError","summary":"Internal server error","id":"paths/~1revenue-holds/get/responses/500/content/application~1json/examples/internalError"},"paths/~1revenue-holds~1{holdId}/get/responses/200/content/application~1json/examples/hold":{"value":{"id":20,"name":"Pending Acceptance","description":"Hold revenue until customer acceptance is received","startDate":"2026-01-01","endDate":null,"eventId":1003,"expiryFieldName":null,"expiryNumberType":null,"expiryDuration":null,"flags":{"enabled":"Y","allowManualRelease":"Y","allowManualApply":"Y","holdType":"Revenue Hold","holdLevel":"RC","scheduleType":"Both"},"createdPeriodId":202601,"clientId":1,"createdBy":"jsmith","createdDate":"2026-01-05","updatedBy":"jsmith","updatedDate":"2026-02-10"},"key":"hold","summary":"Revenue hold","id":"paths/~1revenue-holds~1{holdId}/get/responses/200/content/application~1json/examples/hold"},"paths/~1revenue-holds~1{holdId}/get/responses/400/content/application~1json/examples/invalidHoldId":{"value":{"error":"Invalid value 'x' for parameter 'holdId': expected a valid Long"},"key":"invalidHoldId","summary":"Non-numeric holdId","id":"paths/~1revenue-holds~1{holdId}/get/responses/400/content/application~1json/examples/invalidHoldId"},"paths/~1revenue-holds~1{holdId}/get/responses/404/content/application~1json/examples/notFound":{"value":{"error":"Revenue hold 999 not found"},"key":"notFound","summary":"Revenue hold not found","id":"paths/~1revenue-holds~1{holdId}/get/responses/404/content/application~1json/examples/notFound"},"paths/~1revenue-holds~1{holdId}/get/responses/500/content/application~1json/examples/internalError":{"value":{"error":"Internal server error"},"key":"internalError","summary":"Internal server error","id":"paths/~1revenue-holds~1{holdId}/get/responses/500/content/application~1json/examples/internalError"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/requestBody/content/application~1json/examples/currentVersion":{"value":{},"key":"currentVersion","summary":"Use the current version","id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/requestBody/content/application~1json/examples/currentVersion"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/requestBody/content/application~1json/examples/explicitVersion":{"value":{"objectVersion":5},"key":"explicitVersion","summary":"Explicit version","id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/requestBody/content/application~1json/examples/explicitVersion"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/closed":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract closed successfully"},"key":"closed","summary":"Contract closed","id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/closed"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/opened":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract opened successfully"},"key":"opened","summary":"Contract opened","id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/opened"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is already closed"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/invalidAction":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Action must be either 'open' or 'close'"}]},"key":"invalidAction","summary":"Unsupported action","id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/invalidAction"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1open-close~1{action}/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/requestBody/content/application~1json/examples/unfreeze":{"value":{"action":"UNFREEZE","changeModDate":"Y"},"key":"unfreeze","summary":"Unfreeze and update the modification date","id":"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/requestBody/content/application~1json/examples/unfreeze"},"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/requestBody/content/application~1json/examples/keepModDate":{"value":{"action":"UNFREEZE","changeModDate":"N","objectVersion":5},"key":"keepModDate","summary":"Unfreeze without changing the modification date","id":"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/requestBody/content/application~1json/examples/keepModDate"},"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/unfrozen":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract unfrozen successfully"},"key":"unfrozen","summary":"Contract unfrozen","id":"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/unfrozen"},"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is not frozen"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/engineError":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while unfreezing RC"},"key":"engineError","summary":"Revenue engine error","id":"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/200/content/application~1json/examples/engineError"},"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/missingAction":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"action must not be blank"}]},"key":"missingAction","summary":"Missing action","id":"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/missingAction"},"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1unfreeze/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply":{"value":{"comments":"Hold pending customer acceptance"},"key":"apply","summary":"Apply a contract hold","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Hold applied successfully","holdRecords":[{"id":5001,"rcId":111442,"lineId":0,"rcPobId":0,"revHoldId":20,"bookId":1,"comments":"Hold pending customer acceptance"}]},"key":"applied","summary":"Hold applied","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Hold already applied"},"key":"rejected","summary":"Rejected by a business rule","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while applying holds"},"key":"unexpected","summary":"Unexpected error while applying","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release":{"value":{"comments":"Customer acceptance received","reason":"Acceptance"},"key":"release","summary":"Release a contract hold","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Hold released successfully"},"key":"released","summary":"Hold released","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Hold not found"},"key":"rejected","summary":"Rejected by a business rule","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while releasing hold"},"key":"unexpected","summary":"Unexpected error while releasing","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply":{"value":{"comments":"Audit review","lines":[{"lineId":85922,"holdComments":"Hold on this line"}]},"key":"apply","summary":"Apply a line-level hold","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Hold applied successfully","holdRecords":[{"id":5001,"rcId":111442,"lineId":85922,"rcPobId":0,"revHoldId":20,"bookId":1,"comments":"Hold on this line"}]},"key":"applied","summary":"Hold applied","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Hold already applied"},"key":"rejected","summary":"Rejected by a business rule","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while applying holds"},"key":"unexpected","summary":"Unexpected error while applying","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Lines are required for line-level hold"}]},"key":"missingLines","summary":"No items","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"lineId is mandatory for line-level hold"}]},"key":"missingIdentifier","summary":"Item without lineId","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release":{"value":{"comments":"Audit complete","items":[{"lineId":85922,"releaseComments":"Releasing hold","releaseReason":"Audit complete"}]},"key":"release","summary":"Release a line-level hold","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Hold released successfully"},"key":"released","summary":"Hold released","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Hold not found"},"key":"rejected","summary":"Rejected by a business rule","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while releasing hold"},"key":"unexpected","summary":"Unexpected error while releasing","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Items are required for line-level hold release"}]},"key":"missingItems","summary":"No items","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"lineId is mandatory for line-level hold release"}]},"key":"missingIdentifier","summary":"Item without lineId","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply":{"value":{"comments":"Audit review","lines":[{"rcPobId":156912,"holdComments":"Hold on this POB"}]},"key":"apply","summary":"Apply a POB-level hold","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Hold applied successfully","holdRecords":[{"id":5001,"rcId":111442,"lineId":0,"rcPobId":156912,"revHoldId":20,"bookId":1,"comments":"Hold on this POB"}]},"key":"applied","summary":"Hold applied","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Hold already applied"},"key":"rejected","summary":"Rejected by a business rule","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while applying holds"},"key":"unexpected","summary":"Unexpected error while applying","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Lines are required for POB-level hold"}]},"key":"missingLines","summary":"No items","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"rcPobId is mandatory for POB-level hold"}]},"key":"missingIdentifier","summary":"Item without rcPobId","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release":{"value":{"comments":"Audit complete","items":[{"rcPobId":156912,"releaseComments":"Releasing hold","releaseReason":"Audit complete"}]},"key":"release","summary":"Release a POB-level hold","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Hold released successfully"},"key":"released","summary":"Hold released","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Hold not found"},"key":"rejected","summary":"Rejected by a business rule","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while releasing hold"},"key":"unexpected","summary":"Unexpected error while releasing","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Items are required for POB-level hold release"}]},"key":"missingItems","summary":"No items","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"rcPobId is mandatory for POB-level hold release"}]},"key":"missingIdentifier","summary":"Item without rcPobId","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply":{"value":{"comments":"Audit review","lines":[{"chargeNumber":"C-00012345","holdComments":"Hold on this charge"}]},"key":"apply","summary":"Apply a charge-level hold","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/requestBody/content/application~1json/examples/apply"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Hold applied successfully","holdRecords":[{"id":5001,"rcId":111442,"lineId":85922,"rcPobId":0,"revHoldId":20,"bookId":1,"comments":"Hold on this charge"}]},"key":"applied","summary":"Hold applied","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/applied"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Hold already applied"},"key":"rejected","summary":"Rejected by a business rule","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while applying holds"},"key":"unexpected","summary":"Unexpected error while applying","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/200/content/application~1json/examples/unexpected"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Lines are required for charge-level hold"}]},"key":"missingLines","summary":"No items","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingLines"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"chargeNumber is mandatory for charge-level hold"}]},"key":"missingIdentifier","summary":"Item without chargeNumber","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/missingIdentifier"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1apply/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release":{"value":{"comments":"Audit complete","items":[{"chargeNumber":"C-00012345","releaseComments":"Releasing hold","releaseReason":"Audit complete"}]},"key":"release","summary":"Release a charge-level hold","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/requestBody/content/application~1json/examples/release"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Hold released successfully"},"key":"released","summary":"Hold released","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/released"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Hold not found"},"key":"rejected","summary":"Rejected by a business rule","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while releasing hold"},"key":"unexpected","summary":"Unexpected error while releasing","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/200/content/application~1json/examples/unexpected"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Items are required for charge-level hold release"}]},"key":"missingItems","summary":"No items","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingItems"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"chargeNumber is mandatory for charge-level hold release"}]},"key":"missingIdentifier","summary":"Item without chargeNumber","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/missingIdentifier"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1holds~1{holdId}~1release/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/requestBody/content/application~1json/examples/window":{"value":{"comments":"Deferring revenue pending acceptance","startDate":"2026-01-01","endDate":"2026-03-31"},"key":"window","summary":"Defer for a date window","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/requestBody/content/application~1json/examples/window"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/requestBody/content/application~1json/examples/somePobs":{"value":{"comments":"Deferring revenue for two POBs","rcPobIds":[156912,156913]},"key":"somePobs","summary":"Defer selected POBs","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/requestBody/content/application~1json/examples/somePobs"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue deferred successfully"},"key":"done","summary":"Action completed","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is frozen"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/engineError":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while deferring/releasing RC"},"key":"engineError","summary":"Revenue engine error","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/200/content/application~1json/examples/engineError"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/missingComments":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"comments must not be blank"}]},"key":"missingComments","summary":"Missing comments","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/missingComments"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidDate":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"'startDate' contains an invalid date value '2026-13-01'. Expected format: yyyy-MM-dd"}]},"key":"invalidDate","summary":"Invalid date","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidDate"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-revenue/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/requestBody/content/application~1json/examples/window":{"value":{"comments":"Deferring revenue pending acceptance","startDate":"2026-01-01","endDate":"2026-03-31"},"key":"window","summary":"Defer for a date window","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/requestBody/content/application~1json/examples/window"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue deferred successfully"},"key":"done","summary":"Action completed","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is frozen"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/engineError":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while deferring/releasing RC"},"key":"engineError","summary":"Revenue engine error","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/200/content/application~1json/examples/engineError"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/missingComments":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"comments must not be blank"}]},"key":"missingComments","summary":"Missing comments","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/missingComments"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidDate":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"'startDate' contains an invalid date value '2026-13-01'. Expected format: yyyy-MM-dd"}]},"key":"invalidDate","summary":"Invalid date","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidDate"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1defer-revenue/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/full":{"value":{"comments":"Acceptance received"},"key":"full","summary":"Release all deferred revenue","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/full"},"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/percentage":{"value":{"comments":"Partial acceptance","releasePercentage":50},"key":"percentage","summary":"Release 50 percent","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/percentage"},"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/amount":{"value":{"comments":"Milestone met","releaseAmount":1500},"key":"amount","summary":"Release an amount","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/amount"},"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/somePobs":{"value":{"comments":"Releasing deferred revenue","rcPobIds":[156912],"releasePercentage":100},"key":"somePobs","summary":"Release selected POBs","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/requestBody/content/application~1json/examples/somePobs"},"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue released successfully"},"key":"done","summary":"Action completed","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"No deferred revenue available to release"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/engineError":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while deferring/releasing RC"},"key":"engineError","summary":"Revenue engine error","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/200/content/application~1json/examples/engineError"},"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/missingComments":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"comments must not be blank"}]},"key":"missingComments","summary":"Missing comments","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/missingComments"},"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidDate":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"'startDate' contains an invalid date value '2026-13-01'. Expected format: yyyy-MM-dd"}]},"key":"invalidDate","summary":"Invalid date","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidDate"},"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-revenue/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/full":{"value":{"comments":"Acceptance received"},"key":"full","summary":"Release all deferred revenue","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/full"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/percentage":{"value":{"comments":"Partial acceptance","releasePercentage":50},"key":"percentage","summary":"Release 50 percent","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/percentage"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/amount":{"value":{"comments":"Milestone met","releaseAmount":1500},"key":"amount","summary":"Release an amount","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/requestBody/content/application~1json/examples/amount"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue released successfully"},"key":"done","summary":"Action completed","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"No deferred revenue available to release"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/engineError":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while deferring/releasing RC"},"key":"engineError","summary":"Revenue engine error","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/200/content/application~1json/examples/engineError"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/missingComments":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"comments must not be blank"}]},"key":"missingComments","summary":"Missing comments","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/missingComments"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidDate":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"'startDate' contains an invalid date value '2026-13-01'. Expected format: yyyy-MM-dd"}]},"key":"invalidDate","summary":"Invalid date","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidDate"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1release-revenue/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/requestBody/content/application~1json/examples/defer":{"value":{"lineId":85922,"costTypeId":10000,"comments":"Deferring commission","ruleStartDate":"2026-01-01","ruleEndDate":"2026-12-31"},"key":"defer","summary":"Defer a commission cost","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/requestBody/content/application~1json/examples/defer"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Cost deferred successfully"},"key":"done","summary":"Action completed","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Cost type is not configured for the line"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/engineError":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while deferring/releasing RC"},"key":"engineError","summary":"Revenue engine error","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/200/content/application~1json/examples/engineError"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/missingFields":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"lineId must not be null"},{"code":"ValidationError","message":"costTypeId must not be null"},{"code":"ValidationError","message":"comments must not be blank"}]},"key":"missingFields","summary":"Missing required fields","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/missingFields"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1defer-cost/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/requestBody/content/application~1json/examples/amount":{"value":{"lineId":85922,"costTypeId":10000,"comments":"Releasing deferred commission","releaseAmount":500},"key":"amount","summary":"Release an amount","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/requestBody/content/application~1json/examples/amount"},"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/requestBody/content/application~1json/examples/percentage":{"value":{"lineId":85922,"costTypeId":10000,"comments":"Contract terminated","releasePercentage":100},"key":"percentage","summary":"Release a percentage","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/requestBody/content/application~1json/examples/percentage"},"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Cost released successfully"},"key":"done","summary":"Action completed","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Cost type is not configured for the line"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/engineError":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while deferring/releasing RC"},"key":"engineError","summary":"Revenue engine error","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/200/content/application~1json/examples/engineError"},"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/missingFields":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"lineId must not be null"},{"code":"ValidationError","message":"costTypeId must not be null"},{"code":"ValidationError","message":"comments must not be blank"}]},"key":"missingFields","summary":"Missing required fields","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/missingFields"},"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1release-cost/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/requestBody/content/application~1json/examples/reallocate":{"value":{"action":"REALLOCATE"},"key":"reallocate","summary":"Reallocate","id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/requestBody/content/application~1json/examples/reallocate"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/requestBody/content/application~1json/examples/eligible":{"value":{"action":"ALLOCATION_ELIGIBLE","objectVersion":5},"key":"eligible","summary":"Make allocation-eligible","id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/requestBody/content/application~1json/examples/eligible"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Allocation performed successfully"},"key":"done","summary":"Allocation performed","id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is not eligible for allocation"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/missingAction":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"action must not be blank"}]},"key":"missingAction","summary":"Missing action","id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/missingAction"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/unknownAction":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"No enum constant com.zuora.neo.engine.grpc.manualAction.v1.ReallocationAction.reallocate"}]},"key":"unknownAction","summary":"Unknown action","description":"The value is not one of the allowed values (values are case-sensitive).","id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/unknownAction"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1allocate-action/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/requestBody/content/application~1json/examples/current":{"value":{},"key":"current","summary":"Use the current version","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/requestBody/content/application~1json/examples/current"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/requestBody/content/application~1json/examples/explicit":{"value":{"objectVersion":5},"key":"explicit","summary":"Explicit version","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/requestBody/content/application~1json/examples/explicit"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Allocation switched successfully"},"key":"done","summary":"Allocation switched","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is frozen"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/unexpected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error occurred during switch allocation"},"key":"unexpected","summary":"Unexpected error","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/200/content/application~1json/examples/unexpected"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-allocation/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/requestBody/content/application~1json/examples/minimal":{"value":{"comments":"Segment correction","atr1":"EMEA"},"key":"minimal","summary":"Change one attribute","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/requestBody/content/application~1json/examples/minimal"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/requestBody/content/application~1json/examples/several":{"value":{"comments":"Q4 reporting update","objectVersion":5,"atr1":"EMEA","num1":12.5,"date1":"2026-01-31"},"key":"several","summary":"Change several attributes","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/requestBody/content/application~1json/examples/several"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Line updated successfully"},"key":"done","summary":"Line edited","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is frozen"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/unexpected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while editing line"},"key":"unexpected","summary":"Unexpected error","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/200/content/application~1json/examples/unexpected"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/missingComments":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"comments must not be blank"}]},"key":"missingComments","summary":"Missing comments","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/missingComments"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/invalidDate":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"'date1' contains an invalid date value '31-01-2026'. Expected format: yyyy-MM-dd"}]},"key":"invalidDate","summary":"Invalid date","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/invalidDate"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1{lineId}~1edit/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/requestBody/content/application~1json/examples/bulk":{"value":{"objectVersion":5,"items":[{"name":"Annual Support","pobTemplateId":100,"pobVersion":2,"expiryDate":"2026-12-31","leadLineId":85922,"comments":"Updating POB attributes","id":156912},{"name":"Implementation","pobTemplateId":100,"pobVersion":2,"expiryDate":"2026-12-31","leadLineId":85923,"comments":"Updating POB attributes","id":156913}]},"key":"bulk","summary":"Edit two POBs","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/requestBody/content/application~1json/examples/bulk"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"POB attributes updated successfully"},"key":"done","summary":"POBs edited","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"POB template is not active"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/engineError":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while editing Pob Attributes: UNAVAILABLE: io exception"},"key":"engineError","summary":"Revenue engine error","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/200/content/application~1json/examples/engineError"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/missingItemField":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"items[0].pobTemplateId must not be null"},{"code":"ValidationError","message":"items[0].leadLineId must not be null"}]},"key":"missingItemField","summary":"Missing item field","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/missingItemField"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1edit/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/requestBody/content/application~1json/examples/edit":{"value":{"name":"Annual Support","pobTemplateId":100,"pobVersion":2,"expiryDate":"2026-12-31","leadLineId":85922,"comments":"Updating POB attributes"},"key":"edit","summary":"Edit a POB","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/requestBody/content/application~1json/examples/edit"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"POB attributes updated successfully"},"key":"done","summary":"POB edited","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"POB template is not active"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/engineError":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while editing Pob Attributes"},"key":"engineError","summary":"Revenue engine error","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/200/content/application~1json/examples/engineError"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/missingField":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"name must not be null"}]},"key":"missingField","summary":"Missing field","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/missingField"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1{pobId}~1edit/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/requestBody/content/application~1json/examples/minimal":{"value":{"objectVersion":5,"docLineId":"SO-1001-1","pobName":"Free Training","pobTemplateId":100},"key":"minimal","summary":"Copy with required fields","id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/requestBody/content/application~1json/examples/minimal"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/requestBody/content/application~1json/examples/overrides":{"value":{"objectVersion":5,"docLineId":"SO-1001-1","pobName":"Free Training","pobTemplateId":100,"fvPrice":500,"ordQty":10,"unitSellPrc":0,"extSllPrc":0,"docDate":"2026-01-15","comments":"Adding promised training"},"key":"overrides","summary":"Copy with overrides","id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/requestBody/content/application~1json/examples/overrides"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Copy Line completed successfully"},"key":"done","summary":"Line copied","id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Action not allowed: soft freeze is in progress"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/missingFields":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"objectVersion must not be null"},{"code":"ValidationError","message":"docLineId must not be blank"},{"code":"ValidationError","message":"pobName must not be blank"},{"code":"ValidationError","message":"pobTemplateId must not be null"}]},"key":"missingFields","summary":"Missing required fields","id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/missingFields"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1copyLn/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/requestBody/content/application~1json/examples/switch":{"value":{"lineId":85923,"rcPobId":156912},"key":"switch","summary":"Switch lead line","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/requestBody/content/application~1json/examples/switch"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Lead line switched successfully"},"key":"done","summary":"Lead line switched","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Line does not belong to the POB"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/missingFields":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"lineId must not be null"},{"code":"ValidationError","message":"rcPobId must not be null"}]},"key":"missingFields","summary":"Missing fields","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/missingFields"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1switch-lead-line/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/requestBody/content/application~1json/examples/move":{"value":{"rcPobId":156912,"rcDerivedPobId":156915,"action":"MOVE","comments":"Reclassifying POB"},"key":"move","summary":"Move a POB","id":"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/requestBody/content/application~1json/examples/move"},"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/requestBody/content/application~1json/examples/line":{"value":{"rcPobId":156912,"rcDerivedPobId":156915,"action":"MOVE","lineId":85923,"comments":"Moving one line"},"key":"line","summary":"Move one line","id":"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/requestBody/content/application~1json/examples/line"},"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"POB moved successfully"},"key":"done","summary":"POB moved","id":"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Target POB is not valid for this line"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/engineError":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error occurred while moving Pob"},"key":"engineError","summary":"Revenue engine error","id":"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/200/content/application~1json/examples/engineError"},"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/missingFields":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"rcPobId must not be null"},{"code":"ValidationError","message":"rcDerivedPobId must not be null"},{"code":"ValidationError","message":"comments must not be blank"},{"code":"ValidationError","message":"action must not be blank"}]},"key":"missingFields","summary":"Missing fields","id":"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/missingFields"},"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1move-pob/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/requestBody/content/application~1json/examples/example":{"value":{"targetRcIds":[111450,111451],"comments":"Regrouping per contract review"},"key":"example","summary":"Link contracts into a revenue contract","id":"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/requestBody/content/application~1json/examples/example"},"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Link completed successfully"},"key":"done","summary":"Action completed","id":"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is frozen"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/emptyList":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"targetRcIds must not be empty"}]},"key":"emptyList","summary":"Empty targetRcIds","id":"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/emptyList"},"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1link-rc/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/requestBody/content/application~1json/examples/example":{"value":{"rcPobIds":[156920],"comments":"Regrouping per contract review"},"key":"example","summary":"Link POBs into a revenue contract","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/requestBody/content/application~1json/examples/example"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Link completed successfully"},"key":"done","summary":"Action completed","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is frozen"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/emptyList":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"rcPobIds must not be empty"}]},"key":"emptyList","summary":"Empty rcPobIds","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/emptyList"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1link/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/requestBody/content/application~1json/examples/example":{"value":{"docLineIds":["SO-1001-1","SO-1001-2"],"comments":"Regrouping per contract review","rcPobId":156912},"key":"example","summary":"Link lines into a revenue contract","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/requestBody/content/application~1json/examples/example"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/requestBody/content/application~1json/examples/toLeadLine":{"value":{"docLineIds":["SO-1001-1","SO-1001-2"],"leadLineId":85922,"comments":"Grouping with lead line"},"key":"toLeadLine","summary":"Group under a lead line","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/requestBody/content/application~1json/examples/toLeadLine"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Link completed successfully"},"key":"done","summary":"Action completed","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is frozen"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/emptyList":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"docLineIds must not be empty"}]},"key":"emptyList","summary":"Empty docLineIds","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/emptyList"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1link/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/requestBody/content/application~1json/examples/example":{"value":{"chargeNumbers":["C-00012345"],"comments":"Regrouping per contract review"},"key":"example","summary":"Link charges into a revenue contract","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/requestBody/content/application~1json/examples/example"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Link completed successfully"},"key":"done","summary":"Action completed","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is frozen"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/emptyList":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"chargeNumbers must not be empty"}]},"key":"emptyList","summary":"Empty chargeNumbers","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/emptyList"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1link/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/requestBody/content/application~1json/examples/example":{"value":{"subscriptionIds":["A-S00001234"],"comments":"Regrouping per contract review"},"key":"example","summary":"Link subscriptions into a revenue contract","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/requestBody/content/application~1json/examples/example"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Link completed successfully"},"key":"done","summary":"Action completed","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is frozen"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/emptyList":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"subscriptionIds must not be empty"}]},"key":"emptyList","summary":"Empty subscriptionIds","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/emptyList"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1link/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/requestBody/content/application~1json/examples/example":{"value":{"comments":"Regrouping per contract review"},"key":"example","summary":"Delink a revenue contract","id":"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/requestBody/content/application~1json/examples/example"},"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Delink completed successfully"},"key":"done","summary":"Action completed","id":"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is frozen"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1delink-rc/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/requestBody/content/application~1json/examples/example":{"value":{"rcPobIds":[156912],"comments":"Regrouping per contract review"},"key":"example","summary":"Delink POBs from a revenue contract","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/requestBody/content/application~1json/examples/example"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Delink completed successfully"},"key":"done","summary":"Action completed","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is frozen"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/emptyList":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"rcPobIds must not be empty"}]},"key":"emptyList","summary":"Empty rcPobIds","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/emptyList"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1pobs~1delink/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/requestBody/content/application~1json/examples/example":{"value":{"docLineIds":["SO-1001-2"],"comments":"Regrouping per contract review"},"key":"example","summary":"Delink lines from a revenue contract","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/requestBody/content/application~1json/examples/example"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Delink completed successfully"},"key":"done","summary":"Action completed","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is frozen"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/emptyList":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"docLineIds must not be empty"}]},"key":"emptyList","summary":"Empty docLineIds","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/emptyList"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1lines~1delink/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/requestBody/content/application~1json/examples/example":{"value":{"chargeNumbers":["C-00012345"],"comments":"Regrouping per contract review"},"key":"example","summary":"Delink charges from a revenue contract","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/requestBody/content/application~1json/examples/example"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Delink completed successfully"},"key":"done","summary":"Action completed","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is frozen"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/emptyList":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"chargeNumbers must not be empty"}]},"key":"emptyList","summary":"Empty chargeNumbers","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/emptyList"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1charges~1delink/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/requestBody/content/application~1json/examples/example":{"value":{"subscriptionIds":["A-S00001234"],"comments":"Regrouping per contract review"},"key":"example","summary":"Delink subscriptions from a revenue contract","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/requestBody/content/application~1json/examples/example"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Delink completed successfully"},"key":"done","summary":"Action completed","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract is frozen"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/emptyList":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"subscriptionIds must not be empty"}]},"key":"emptyList","summary":"Empty subscriptionIds","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/emptyList"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1subscriptions~1delink/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/requestBody/content/application~1json/examples/undo":{"value":{"objectVersion":5,"comments":"Reverting accidental delink"},"key":"undo","summary":"Undo a delink","id":"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/requestBody/content/application~1json/examples/undo"},"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Undo delink completed successfully"},"key":"done","summary":"Delink undone","id":"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"No delink found to undo"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/missingVersion":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"objectVersion must not be null"}]},"key":"missingVersion","summary":"Missing objectVersion","id":"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/missingVersion"},"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1undoDelink/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1create-manual/post/requestBody/content/application~1json/examples/fromContracts":{"value":{"rcIds":[111450,111451],"groupingTemplate":5,"comments":"Manual grouping for Q2"},"key":"fromContracts","summary":"Group whole contracts","id":"paths/~1revenue-management~1contracts~1create-manual/post/requestBody/content/application~1json/examples/fromContracts"},"paths/~1revenue-management~1contracts~1create-manual/post/requestBody/content/application~1json/examples/fromPobs":{"value":{"rcPobIds":[{"id":156912,"retain":false}],"docLineIds":["SO-2001-1"],"comments":"Manual grouping for Q2"},"key":"fromPobs","summary":"Group POBs and lines","id":"paths/~1revenue-management~1contracts~1create-manual/post/requestBody/content/application~1json/examples/fromPobs"},"paths/~1revenue-management~1contracts~1create-manual/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract created successfully"},"key":"done","summary":"Contract created","id":"paths/~1revenue-management~1contracts~1create-manual/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1create-manual/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"No eligible POBs selected"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1create-manual/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1create-manual/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1create-manual/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1create-manual/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1create-manual/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1create-manual/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1create-manual/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1create-manual/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1create-manual/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1create-manual/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1create-manual/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1create-manual/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1create-manual/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1create-manual/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1create-manual/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1create-manual/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/200/content/application~1json/examples/types":{"value":[{"id":1,"value":"Rebate"},{"id":2,"value":"Volume Discount"}],"key":"types","summary":"Applicable types","id":"paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/200/content/application~1json/examples/types"},"paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/200/content/application~1json/examples/none":{"value":[],"key":"none","summary":"No applicable type","id":"paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/200/content/application~1json/examples/none"},"paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1vc-types/get/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/estimate":{"value":{"rcLineId":85922,"vcTypeId":1,"applyValue":1000,"applyType":"AMOUNT","vcRuleType":"E","comments":"Q1 rebate estimate"},"key":"estimate","summary":"Apply an estimated rebate","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/estimate"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/percent":{"value":{"rcLineId":85922,"vcTypeId":2,"applyValue":5,"applyType":"PERCENT","vcRuleType":"A"},"key":"percent","summary":"Apply a percentage","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/percent"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/dryRun":{"value":{"rcLineId":85922,"vcTypeId":1,"applyValue":1000,"applyType":"AMOUNT","vcRuleType":"E","dryRun":true},"key":"dryRun","summary":"Preview only","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/requestBody/content/application~1json/examples/dryRun"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/applied":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Variable consideration applied successfully","rcLineAdjustmentRecords":[{"id":7001,"lineId":85922,"rcId":111442,"bookId":1,"vcTypeId":1}]},"key":"applied","summary":"Variable consideration applied","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/applied"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/preview":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Preview generated","previewData":"{\"lineId\":85922,\"adjustmentAmount\":\"1000.00\"}"},"key":"preview","summary":"Dry-run preview","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/preview"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Variable consideration type is already applied to the line"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/unexpected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error applying VC"},"key":"unexpected","summary":"Unexpected error","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/200/content/application~1json/examples/unexpected"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/missingFields":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"rcLineId must not be null"},{"code":"ValidationError","message":"vcTypeId must not be null"},{"code":"ValidationError","message":"applyValue must not be null"},{"code":"ValidationError","message":"applyType must not be null"},{"code":"ValidationError","message":"vcRuleType must not be null"}]},"key":"missingFields","summary":"Missing required fields","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/missingFields"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidRuleType":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"No enum constant com.zuora.neo.engine.grpc.manualAction.v1.variableconsideration.VcRuleType.X"}]},"key":"invalidRuleType","summary":"Invalid vcRuleType","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidRuleType"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidApplyType":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"No enum constant com.zuora.neo.engine.grpc.manualAction.v1.variableconsideration.ApplyType.AMT"}]},"key":"invalidApplyType","summary":"Invalid applyType","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidApplyType"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-vc/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/requestBody/content/application~1json/examples/expire":{"value":{"rcLinePriceAdjustmentId":7001,"amount":250},"key":"expire","summary":"Expire an amount","id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/requestBody/content/application~1json/examples/expire"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Variable consideration expired successfully"},"key":"done","summary":"Variable consideration expired","id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Expiry amount exceeds the remaining variable consideration"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/unexpected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while processing VC expiry"},"key":"unexpected","summary":"Unexpected error","id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/200/content/application~1json/examples/unexpected"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/missingFields":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"rcLinePriceAdjustmentId must not be null"},{"code":"ValidationError","message":"amount must not be null"}]},"key":"missingFields","summary":"Missing fields","id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/missingFields"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1expire-vc/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/requestBody/content/application~1json/examples/impair":{"value":{"lines":[{"id":85922,"comments":"Customer credit impaired","impairmentType":"1"}]},"key":"impair","summary":"Impair a line","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/requestBody/content/application~1json/examples/impair"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Impairment applied successfully"},"key":"done","summary":"Impairment applied","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Line is not eligible for impairment"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/engineError":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while applying impairment"},"key":"engineError","summary":"Revenue engine error","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/200/content/application~1json/examples/engineError"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/emptyLines":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"lines must not be empty"}]},"key":"emptyLines","summary":"No lines","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/emptyLines"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/missingLineFields":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"lines[0].comments must not be blank"},{"code":"ValidationError","message":"lines[0].impairmentType must not be blank"}]},"key":"missingLineFields","summary":"Missing line fields","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/missingLineFields"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/objectVersionUnresolved":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"objectVersion was not supplied and could not be resolved from DB for rcId=111442, bookId=1"}]},"key":"objectVersionUnresolved","summary":"Object version cannot be resolved","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was omitted and the contract has no stored version. Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"objectVersion"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" explicitly."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/objectVersionUnresolved"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/404/content/application~1json/examples/contractNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NotFound","message":"Revenue contract not found for rcId=999999, bookId=1"}]},"key":"contractNotFound","summary":"Revenue contract not found","description":"The contract does not exist in the book, or the caller's organization cannot see it.","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/404/content/application~1json/examples/contractNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1apply-impairment/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/requestBody/content/application~1json/examples/edit":{"value":{"items":[{"id":12345,"quantity":10,"usageAmount":250,"unitPrice":25}]},"key":"edit","summary":"Correct a usage record","id":"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/requestBody/content/application~1json/examples/edit"},"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Edit usage completed"},"key":"done","summary":"Usage edited","id":"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"No usage record found"},"key":"rejected","summary":"Rejected by a business rule","id":"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/emptyItems":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"items must not be empty"}]},"key":"emptyItems","summary":"No items","id":"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/emptyItems"},"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/invalidId":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"items[0].id must be greater than 0"}]},"key":"invalidId","summary":"Invalid usage ID","id":"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/invalidId"},"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1edit-usage/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/requestBody/content/application~1json/examples/cancel":{"value":{"usageId":12345},"key":"cancel","summary":"Cancel a usage record","id":"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/requestBody/content/application~1json/examples/cancel"},"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Usage record cancelled successfully"},"key":"done","summary":"Usage cancelled","id":"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"No usage record found with id: 12345"},"key":"rejected","summary":"Rejected by a business rule","id":"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/missingId":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"usageId must not be null"}]},"key":"missingId","summary":"Missing usageId","id":"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/missingId"},"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/invalidId":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"usageId must be greater than 0"}]},"key":"invalidId","summary":"Invalid usageId","id":"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/invalidId"},"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/engineRejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"FAILED_PRECONDITION","message":"Service call failed. Please try again or contact support."}]},"key":"engineRejected","summary":"Rejected by the revenue engine","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue engine rejected the request as invalid for the contract's current state ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ARGUMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED_PRECONDITION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OUT_OF_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/400/content/application~1json/examples/engineRejected"},"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/403/content/application~1json/examples/permissionDenied":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"PERMISSION_DENIED","message":"Service call failed. Please try again or contact support."}]},"key":"permissionDenied","summary":"Not permitted","id":"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/403/content/application~1json/examples/permissionDenied"},"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/404/content/application~1json/examples/engineNotFound":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"NOT_FOUND","message":"Service call failed. Please try again or contact support."}]},"key":"engineNotFound","summary":"Object not found by the revenue engine","id":"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/404/content/application~1json/examples/engineNotFound"},"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/409/content/application~1json/examples/conflict":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ABORTED","message":"Service call failed. Please try again or contact support."}]},"key":"conflict","summary":"Concurrent update","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Another update to the same contract was in progress, or the object already exists ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ABORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALREADY_EXISTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Read the contract again and retry."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/409/content/application~1json/examples/conflict"},"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/429/content/application~1json/examples/resourceExhausted":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"RESOURCE_EXHAUSTED","message":"Service call failed. Please try again or contact support."}]},"key":"resourceExhausted","summary":"Engine capacity exceeded","id":"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/429/content/application~1json/examples/resourceExhausted"},"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/503/content/application~1json/examples/unavailable":{"value":{"reasons":[{"code":"UNAVAILABLE","message":"Service call failed. Please try again or contact support."}]},"key":"unavailable","summary":"Revenue engine unavailable","id":"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/503/content/application~1json/examples/unavailable"},"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/504/content/application~1json/examples/timeout":{"value":{"reasons":[{"code":"DEADLINE_EXCEEDED","message":"Service call failed. Please try again or contact support."}]},"key":"timeout","summary":"Revenue engine timeout","id":"paths/~1revenue-management~1contracts~1{rcId}~1usage-cancel/post/responses/504/content/application~1json/examples/timeout"},"paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/requestBody/content/application~1json/examples/void":{"value":{"billDocNumber":"INV00012345","reason":"Duplicate invoice","comment":"Customer requested void"},"key":"void","summary":"Void an invoice","id":"paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/requestBody/content/application~1json/examples/void"},"paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Billing voided successfully"},"key":"done","summary":"Billing voided","id":"paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Billing document not found on the revenue contract"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/engineError":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while applying void billing"},"key":"engineError","summary":"Revenue engine error","id":"paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/200/content/application~1json/examples/engineError"},"paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/missingFields":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"ValidationError","message":"billDocNumber must not be blank"},{"code":"ValidationError","message":"reason must not be blank"}]},"key":"missingFields","summary":"Missing fields","id":"paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/missingFields"},"paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/malformedBody":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"Request body is malformed or contains invalid values"}]},"key":"malformedBody","summary":"Malformed request body","description":"The body is missing, is not valid JSON, or a field has the wrong type (for example text in a numeric field).","id":"paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/malformedBody"},"paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1void-billing/post/responses/500/content/application~1json/examples/systemError"},"paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/done":{"value":{"success":true,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Forecast Generated Successfully"},"key":"done","summary":"Forecast generated","id":"paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/done"},"paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/rejected":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Revenue contract has no forecastable lines"},"key":"rejected","summary":"Rejected by a business rule (illustrative message)","id":"paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/rejected"},"paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/engineError":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","message":"Error while generating forecast for rc 111442"},"key":"engineError","summary":"Revenue engine error","id":"paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/200/content/application~1json/examples/engineError"},"paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/400/content/application~1json/examples/invalidBookHeader":{"value":{"success":false,"processId":"3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11","requestId":"a7d2e5f0-1c3b-4e8a-9f6d-2b4c6e8a0d13","reasons":[{"code":"InvalidRequest","message":"For input string: \"abc\""}]},"key":"invalidBookHeader","summary":"Invalid book header","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"X-REV-BOOK-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not numeric."},"children":[]}]}]}],"id":"paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/400/content/application~1json/examples/invalidBookHeader"},"paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/500/content/application~1json/examples/systemError":{"value":{"reasons":[{"code":"SystemError","message":"internal server error"}]},"key":"systemError","summary":"Internal server error","id":"paths/~1revenue-management~1contracts~1{rcId}~1generate-forecast/post/responses/500/content/application~1json/examples/systemError"}},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer {{token}}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header for authentication."},"children":[]}]}]}]},"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic","description":"The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.\n"},"OneIdOAuth":{"id":"OneIdOAuth","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zuora OneID OAuth 2.0 client credentials. Send the access token as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <access_token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://one.zuora.com/oauth2/token","scopes":{}}}}},"servers":[{"url":"https://one.zuora.com","description":"Zuora OneID production URL."}],"logo":{"imageUrl":"https://www.zuora.com/wp-content/uploads/2016/10/zuora-dev-logo-api-ref.svg"},"specType":"openapi"},"options":{"codeSamples":{"languages":[{"lang":"Payload","label":"Payload"},{"lang":"curl","label":"cURL"}]},"mockServer":{"url":"/_mock/other-api/revenue-api-3.0","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/other-api/revenue-api-3.0.json?download"},{"url":"/_bundle/other-api/revenue-api-3.0.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Revenue API Reference","description":"\n# Introduction\n\n\nWelcome to the reference for Zuora Revenue REST API!\n\n\nREST is a web-service protocol that lends itself to rapid development by \nusing everyday HTTP and JSON technology. Zuora Revenue provides various REST \nAPIs for data integration. Use these REST APIs to authenticate and integrate \ndata from the source ERP systems with Zuora Revenue.\n\n\nAll Zuora Revenue REST APIs are secured by using HTTPS. The authentication scheme is token-based authentication, \nwhich means an authenticated user must generate a token and then use it for all subsequent APIs until the token expires.\n\n\nThis reference provides detailed descriptions about functions, requests, and responses of each REST API.\n\nZuora Revenue REST APIs can be broadly classified into the following categories:\n\n * Authentication\n\n * Inbound\n\n * Outbound \n \n**Remember:** \n\n\n * The API service must be enabled for your tenant in the first place. Otherwise, the 405 error will be returned for every API request you submitted. To enable the API service, contact Zuora Revenue Support.\n\n * Both the inbound and outbound operations require an authentication token to perform integration.\nYou can obtain the token by using the Authentication operation.\n\n\n## Endpoints\n\nAfter the APIs are provisioned in Zuora Revenue Cloud, you can get the endpoint and use that endpoint to call the APIs.\n\n\n\n## Requirements\n\nBefore you use the Zuora Revenue APIs, make sure the following requirements are met:\n\n  * Zuora Revenue uses role based access control to restrict system access to authorized users. \nTo use the Zuora Revenue APIs, make sure that your user role has the **Webservices Inbound** \nand **Webservices Outbound** previleges in Zuora Revenue security settings. For more information, \nsee <a href=\"https://docs.zuora.com?resourceId=revenue-user-mgmt-access\" target=\"_blank\">Manage User Access</a>.      \n  * To use the inbound operations to upload data into Zuora Revenue, the upload templates must be created by using the **File Upload** menu options in the Zuora Revenue UI. \n  Currently, the APIs support transaction upload, bundle upload, and event upload.\n  * To use the outbound operations, the outbound GL interface mapping must be set up in the Zuora Revenue UI (**Setups > Application > Interface Setup**). \n\n\n## Requests and Responses\n\nZuora Revenue APIs support the JSON format of HTTP responses. Inbound operations for data upload support the CSV format only.\n\n\n## Inbound Data Error\n\nAll the inbound data into Zuora Revenue are first loaded into pre-stage tables, namely CUST_UI tables in Zuora Revenue,\nand then pushed to the corresponding staging tables from CUST_UI tables. \n\n\nIf the data fails in the CUST_UI tables, the entire batch of records will be marked as `Failed`.\nIt means All or Nothing approach will be followed when data is being inserted to the CUST_UI tables. \nIf the data has been successfully inserted into the CUST_UI tables, it will then be automatically pushed to \nthe staging tables and no manual work is required. \n\n\nAny uncollected data that remains in the staging tables can be manually fixed or downloaded, and can be reposted from the upstream systems. \n\n\nYou can use the Stage Error operations to retrieve error information about the uploaded data.\n"}},"baseSlug":"/other-api/revenue-api-3.0","routesMapping":{}}