PUT /v1/journal-entries/{je-number}/basic-information

This REST API reference describes how to update the basic information of a summary journal entry. Request and response field descriptions and sample code are provided.

Servers

Path parameters

Name Type Required Description
je-number String Yes

Journal entry number in the format JE-00000001.

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.

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
notes String No

Additional information about this record.

Character limit: 2,000

journalEntryItems[] Array No

Key name that represents the list of journal entry items.

journalEntryItems[].type String Yes

Type of journal entry item.

Possible values:

  • "Debit"
  • "Credit"
journalEntryItems[].accountingCodeName String Yes

Name of the accounting code.

If the Journal Entry Item has a blank accounting code, enter the empty string.

journalEntryItems[].accountingCodeType String No

Accounting code type.

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"
transferredToAccounting String No

Status shows whether the journal entry has been transferred to an accounting system.

This field cannot be changed after the summary journal entry has been canceled.

Note: The Zuora Finance Override Transferred to Accounting permission is required to change transferredToAccounting from Yes to any other value.

Possible values:

  • "Processing"
  • "Error"
  • "Yes"
  • "Ignore"
  • "No"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.