{ "opencollection": "1.0.0", "info": { "name": "API Reference Accounting Codes Accounting Periods API", "version": "2023-12-15" }, "items": [ { "info": { "name": "Accounting Periods", "type": "folder" }, "items": [ { "info": { "name": "Close an accounting period", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/accounting-periods/:ap-id/close", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ap-id", "value": "", "type": "path", "description": "ID of the accounting period you want to close." } ] }, "docs": "Close an accounting period by accounting period ID.\n\nPrerequisites\n-------------\nYou must have Zuora Finance enabled on your tenant. You must have the Manage Close Process and Run Trial Balance user permissions.\n\nLimitations\n-----------\n* The accounting period cannot already be closed.\n* The accounting period cannot be in the process of running a trial balance.\n* All earlier accounting periods must be closed.\n* There must be no required action items for the accounting period. See Reconcile Trans" }, { "info": { "name": "Set an accounting period to pending close", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/accounting-periods/:ap-id/pending-close", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ap-id", "value": "", "type": "path", "description": "ID of the accounting period you want to set to pending close." } ] }, "docs": "Sets an accounting period to pending close.\n\n\nPrerequisites\n-------------\n\n* You must have Zuora Finance enabled on your tenant.\n* You must have the Manage Close Process and Run Trial Balance user permissions.\n\n \nLimitations \n -----------\n \n * The accounting period cannot be closed or pending close.\n \n * The accounting period cannot be in the process of running a trial balance.\n \n * All earlier accounting periods must be closed.\n \n \nNotes\n-----\nWhen you set an accounting period to pen" }, { "info": { "name": "List all accounting periods", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/accounting-periods", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "page", "value": "", "type": "query", "description": "The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.\n" }, { "name": "pageSize", "value": "", "type": "query", "description": "The number of records returned per page in the response.\n" } ] }, "docs": "Retrieves all accounting periods on your tenant." }, { "info": { "name": "Create an accounting period", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/accounting-periods", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ] }, "docs": "Creates an accounting period.\nPrerequisites\n-------------\n* You must have Zuora Finance enabled on your tenant.\n* You must have the Create Accounting Period user permission.\n\nLimitations\n-----------\n* When creating the first accounting period on your tenant, the start date must be equal to or earlier than the date of the earliest transaction on the tenant.\n* Start and end dates of accounting periods must be contiguous. For example, if one accounting period ends on January 31, the next period mus" }, { "info": { "name": "Retrieve an accounting period", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/accounting-periods/:ap-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ap-id", "value": "", "type": "path", "description": "ID of the accounting period you want to get." } ] }, "docs": "Retrieves an accounting period.\nPrerequisites\n-------------\n\nYou must have Zuora Finance enabled on your tenant.\n" }, { "info": { "name": "Update an accounting period", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/accounting-periods/:ap-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ap-id", "value": "", "type": "path", "description": "ID of the accounting period you want to update." } ] }, "docs": "\nUpdates an accounting period.\n\nPrerequisites\n-------------\n\n* You must have Zuora Finance enabled on your tenant.\n\n* You must have the Create Accounting Period user permission. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).\n\nLimitations\n-----------\n\n* You can update the start date of only the earliest accounting period on your tenant. You cannot update the start date of later periods.\n\n* If you update the e" }, { "info": { "name": "Delete an accounting period", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/accounting-periods/:ap-id", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ap-id", "value": "", "type": "path", "description": "ID of the accounting period you want to delete." } ] }, "docs": "Deletes an accounting period.\n\nPrerequisites\n-------------\n\n * You must have Zuora Finance enabled on your tenant.\n\n * You must have the Delete Accounting Period user permission. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).\n\n\nLimitations\n-----------\n\nThe accounting period to be deleted:\n\n* Must be the most recent accounting period\n\n* Must be an open accounting period\n\n* Must have no revenue distributed int" }, { "info": { "name": "Reopen an accounting period", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/accounting-periods/:ap-id/reopen", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ap-id", "value": "", "type": "path", "description": "ID of the accounting period that you want to re-open." } ] }, "docs": "Re-opens an accounting period.\nPrerequisites\n-------------\n* You must have Zuora Finance enabled on your tenant.\n* You must have the Manage Close Process and Run Trial Balance user permissions.\n\nLimitations\n-----------\n* The accounting period must be closed or pending close.\n* You can only re-open an accounting period that is immediately previous to an open period." }, { "info": { "name": "Run trial balance", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/accounting-periods/:ap-id/run-trial-balance", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" } ], "params": [ { "name": "ap-id", "value": "", "type": "path", "description": "ID of the accounting period for which you want to run a trial balance." } ] }, "docs": "Runs the trial balance for an accounting period. \n\nPrerequisites\n-------------\n\n* You must have Zuora Finance enabled on your tenant.\n\n* You must have the Manage Close Process and Run Trial Balance user permissions. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).\n\n \nLimitations \n-----------\n \n * The accounting period must be open.\n \n * The accounting period cannot already be in the process of running" } ] } ], "bundled": true }