POST /v1/journal-entries

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

Requirements

1.The sum of debits must equal the sum of credits in the summary journal entry.

2.The following applies only if you use foreign currency conversion:

If you have configured Aggregate transactions with different currencies during a Journal Run to "Yes", the value of the currency field must be the same as your tenant's home currency. That is, you must create journal entries using your home currency.
All journal entries in an accounting period must either all be aggregated or all be unaggregated. You cannot have a mix of aggregated and unaggregated journal entries in the same accounting period.

Servers

https://rest.test.zuora.com
https://rest.sandbox.na.zuora.com
https://rest.apisandbox.zuora.com
https://rest.na.zuora.com
https://rest.zuora.com
https://rest.test.eu.zuora.com
https://rest.sandbox.eu.zuora.com
https://rest.eu.zuora.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Content-Encoding`	String	No	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	No	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 (`'`).
`Authorization`	String	No	The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling Create an OAuth token.
`Idempotency-Key`	String	No	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.
`Zuora-Entity-Ids`	String	No	An entity ID. If you have Zuora 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 do not need to set this header.
`Zuora-Org-Ids`	String	No	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. If the header is not set, the operation is performed in scope of the user's accessible orgs.
`Accept-Encoding`	String	No	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.

Request body fields

Name	Type	Required	Description
`accountingPeriodName`	String	Yes	Name of the accounting period. The open-ended accounting period is named `Open-Ended`.
`journalEntryDate`	String	Yes	Date of the journal entry.
`notes`	String	No	The number associated with the revenue event. Character limit: 2,000
`journalEntryItems[]`	Array	Yes	Key name that represents the list of journal entry items.
`journalEntryItems[].homeCurrencyAmount`	String	No	Journal entry item amount in home currency. This field is required if you have set your home currency for foreign currency conversion. Otherwise, do not pass this field.
`journalEntryItems[].amount`	String	Yes	Journal entry item amount in transaction currency.
`journalEntryItems[].type`	String	Yes	Type of journal entry item. Possible values: `"Debit"` `"Credit"`
`journalEntryItems[].accountingCodeName`	String	Yes	Name of the accounting code.
`journalEntryItems[].accountingCodeType`	String	No	Accounting code type. This field is required if `accountingCodeName` is not unique. Note that `On-Account Receivable` is only available if you enable the Invoice Settlement feature. Possible values: `"On-Account Receivable"` `"OtherRevenue"` `"CustomerCashOnAccount"` `"DeferredRevenue"` `"OtherLiabilities"` `"AccountsReceivable"` `"SalesDiscounts"` `"Cash"` `"OtherEquity"` `"SalesRevenue"` `"SalesTaxPayable"` `"OtherAssets"` `"OtherExpenses"` `"BadDebt"`
`segments[]`	Array	No	List of segments that apply to the summary journal entry.
`segments[].segmentName`	String	Yes	Name of segment. You must use the segment name that has already been specified in the default segment rule. In addition, segments need to be passed in the order where they were defined in the segmentation rule. If multiple segments are configured in the default rule, you need to specify all of them in order.
`segments[].segmentValue`	String	Yes	Value of segment in this summary journal entry.
`transferredToAccounting`	String	No	Status shows whether the journal entry has been transferred to an accounting system. Possible values: `"Processing"` `"Error"` `"Yes"` `"Ignore"` `"No"`
`organizationLabel`	String	No	Name of the organization that the journal entry belongs to. This field is only required when you have already turned on Multi-Org feature.
`currency`	String	Yes	The type of currency used. Currency must be active.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.