---
title: "Create a journal run"
method: POST
path: "/v1/journal-runs"
tags: ["Journal Runs"]
---

# Create a journal run

`POST /v1/journal-runs`

This REST API reference describes how to create a journal run. Request and response field descriptions and sample code are provided.

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Request body

- POSTJournalRunType
  - `accountingPeriodName` string — 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`.
  - `journalEntryDate` string, date, required — Date of the journal entry.
  - `organizationLabels` object — 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 — The organization ID.
    - `organizationName` string — The organization name.
  - `targetEndDate` string, date — 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` string, date — 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`.
  - `transactionTypes` POSTJournalRunTransactionType[], required — Transaction types included in the journal run. You can include one or more transaction types.
    - `type` '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', 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.

## Response `200`

OK

- POSTJournalRunResponseType
  - `journalRunNumber` string — Journal run number.
  - `success` boolean — Returns `true` if the request was processed successfully.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)