> This page is for Developers. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://zuora.ferndocs.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://zuora.ferndocs.com/_mcp/server. # Create a journal run POST https://rest.test.zuora.com/v1/journal-runs Content-Type: application/json This REST API reference describes how to create a journal run. Request and response field descriptions and sample code are provided. Reference: https://zuora.ferndocs.com/developers/api-reference/zuora-api/finance/journal-runs/post-journal-run ## Authentication - `Authorization` header (bearer token, required) — Use `Bearer {{token}}` in the `Authorization` header for authentication. ## Servers - `https://rest.test.zuora.com` (US Developer & Central Sandbox (incl. Test Drive), default) - `https://rest.sandbox.na.zuora.com` (US API Sandbox Cloud 1) - `https://rest.apisandbox.zuora.com` (US API Sandbox Cloud 2) - `https://rest.na.zuora.com` (US Production Cloud 1) - `https://rest.zuora.com` (US Production Cloud 2) - `https://rest.test.eu.zuora.com` (EU Developer & Central Sandbox) - `https://rest.sandbox.eu.zuora.com` (EU API Sandbox) - `https://rest.eu.zuora.com` (EU Production) - `https://rest.test.ap.zuora.com` (APAC Developer & Central Sandbox) - `https://rest.ap.zuora.com` (APAC Production) ## Request ### Headers - `Idempotency-Key` (string, optional) — Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. - `Accept-Encoding` (string, optional) — Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it. - `Content-Encoding` (string, optional) — Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload. - `Zuora-Track-Id` (string, optional) — A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`'`). - `Zuora-Entity-Ids` (string, optional) — An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header. - `Zuora-Org-Ids` (string, optional) — Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header. The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs. - `Zuora-Version` (string, optional) — The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). ### Body (application/json) This endpoint expects a POSTJournalRunType. - `journalEntryDate` (date, required) — Date of the journal entry. - `transactionTypes` (list of POSTJournalRunTransactionType, required) — Transaction types included in the journal run. You can include one or more transaction types. - `accountingPeriodName` (string, optional) — Name of the accounting period. This field determines the target start and end dates of the journal run. Required if you do not include `targetStartDate` and `targetEndDate`. - `organizationLabels` (PostJournalRunTypeOrganizationLabels, optional) — The organization that this run is created for. For each item in the array, either the `organizationId` or the `organizationName` field is required. This field is only required when you have already turned on Multi-Org feature. - `targetEndDate` (date, optional) — The target end date of the journal run. If you include `accountingPeriodName`, the `targetEndDate` must be empty or the same as the end date of the accounting period specified in `accountingPeriodName`. - `targetStartDate` (date, optional) — The target start date of the journal run. Required if you include targetEndDate. If you include `accountingPeriodName`, the `targetStartDate` must be empty or the same as the start date of the accounting period specified in `accountingPeriodName`. ## Response ### 200 OK - `journalRunNumber` (string, optional) — Journal run number. - `success` (boolean, optional) — Returns `true` if the request was processed successfully. ## Errors ### 500 Internal Server Error Internal Server Error - `reasons` (list of ErrorResponseReasonsItems, optional) ### 400 Client Request Error Request Errors - `processId` (string, optional) — The ID of the process that handles the operation. - `reasons` (list of CommonResponseReasonsItems, optional) — The container of the error code and message. This field is available only if the `success` field is `false`. - `requestId` (string, optional) — Unique identifier of the request. - `success` (boolean, optional) — Indicates whether the call succeeded. ## Types ### POSTJournalRunTransactionType - `type` (enum, required) — Transaction type. Invoice Adjustment is deprecated on Production. Zuora recommends that you use the Invoice Item Adjustment instead. If you enable the Invoice Settlement feature, Debit Memo Item, Credit Memo Item, and Credit Memo Application Item are available, Payment and Refund will be replaced by Payment Application and Refund Application. If you enable both the Invoice Settlement feature and the Invoice Item Settlement feature, Payment and Refund will be replaced by Payment Application Item and Refund Application Item. - Allowed values: `Invoice Item`, `Taxation Item`, `Invoice Item Adjustment (Invoice)`, `Invoice Item Adjustment (Tax)`, `Invoice Adjustment`, `Electronic Payment`, `External Payment`, `Electronic Refund`, `External Refund`, `Electronic Credit Balance Payment`, `External Credit Balance Payment`, `Electronic Credit Balance Refund`, `External Credit Balance Refund`, `Credit Balance Adjustment (Applied from Credit Balance)`, `Credit Balance Adjustment (Transferred to Credit Balance)`, `Revenue Event Item`, `Debit Memo Item (Charge)`, `Debit Memo Item (Tax)`, `Credit Memo Item (Charge)`, `Credit Memo Item (Tax)`, `Credit Memo Application Item`, `Electronic Payment Application`, `External Payment Application`, `Electronic Refund Application`, `External Refund Application`, `Electronic Payment Application Item`, `External Payment Application Item`, `Electronic Refund Application Item`, `External Refund Application Item` ### PostJournalRunTypeOrganizationLabels The organization that this run is created for. For each item in the array, either the `organizationId` or the `organizationName` field is required. This field is only required when you have already turned on Multi-Org feature. - `organizationId` (string, optional) — The organization ID. - `organizationName` (string, optional) — The organization name. ### ErrorResponseReasonsItems - `code` (string, optional) — The error code of response. - `message` (string, optional) — The detail information of the error response ### CommonResponseReasonsItems - `code` (string, optional) — The error code of response. - `message` (string, optional) — The detail information of the error response ## Examples **Request** ```json { "journalEntryDate": "2014-11-04", "transactionTypes": [ { "type": "Invoice Item" }, { "type": "Revenue Event Item" } ], "accountingPeriodName": "Nov-2014" } ``` **Response** ```json { "journalRunNumber": "JR-00000008", "success": true } ``` **SDK Code** ```python response import requests url = "https://rest.test.zuora.com/v1/journal-runs" payload = { "journalEntryDate": "2014-11-04", "transactionTypes": [{ "type": "Invoice Item" }, { "type": "Revenue Event Item" }], "accountingPeriodName": "Nov-2014" } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript response const url = 'https://rest.test.zuora.com/v1/journal-runs'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"journalEntryDate":"2014-11-04","transactionTypes":[{"type":"Invoice Item"},{"type":"Revenue Event Item"}],"accountingPeriodName":"Nov-2014"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go response package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://rest.test.zuora.com/v1/journal-runs" payload := strings.NewReader("{\n \"journalEntryDate\": \"2014-11-04\",\n \"transactionTypes\": [\n {\n \"type\": \"Invoice Item\"\n },\n {\n \"type\": \"Revenue Event Item\"\n }\n ],\n \"accountingPeriodName\": \"Nov-2014\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby response require 'uri' require 'net/http' url = URI("https://rest.test.zuora.com/v1/journal-runs") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"journalEntryDate\": \"2014-11-04\",\n \"transactionTypes\": [\n {\n \"type\": \"Invoice Item\"\n },\n {\n \"type\": \"Revenue Event Item\"\n }\n ],\n \"accountingPeriodName\": \"Nov-2014\"\n}" response = http.request(request) puts response.read_body ``` ```java response import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://rest.test.zuora.com/v1/journal-runs") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"journalEntryDate\": \"2014-11-04\",\n \"transactionTypes\": [\n {\n \"type\": \"Invoice Item\"\n },\n {\n \"type\": \"Revenue Event Item\"\n }\n ],\n \"accountingPeriodName\": \"Nov-2014\"\n}") .asString(); ``` ```php response request('POST', 'https://rest.test.zuora.com/v1/journal-runs', [ 'body' => '{ "journalEntryDate": "2014-11-04", "transactionTypes": [ { "type": "Invoice Item" }, { "type": "Revenue Event Item" } ], "accountingPeriodName": "Nov-2014" }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp response using RestSharp; var client = new RestClient("https://rest.test.zuora.com/v1/journal-runs"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"journalEntryDate\": \"2014-11-04\",\n \"transactionTypes\": [\n {\n \"type\": \"Invoice Item\"\n },\n {\n \"type\": \"Revenue Event Item\"\n }\n ],\n \"accountingPeriodName\": \"Nov-2014\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift response import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "journalEntryDate": "2014-11-04", "transactionTypes": [["type": "Invoice Item"], ["type": "Revenue Event Item"]], "accountingPeriodName": "Nov-2014" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://rest.test.zuora.com/v1/journal-runs")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```