Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Summary Journal Entries > Update Basic Information of a Summary Journal Entry

Update Basic Information of a Summary Journal Entry

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.

Request

  • Production: PUT https://api.zuora.com/rest/v1/journal-entries/{je-number}/basic-information
  • API Sandbox: PUT https://apisandbox-api.zuora.com/rest/v1/journal-entries/{je-number}/basic-information

Request Header

The Accept request header is optional. Only JSON is returned.

Request Parameters

je-number

required

path

Journal entry number in the format JE-00000001.

{je-number} must be a valid journal entry number in the format JE-00000001

Request Body

transferredToAccounting

optional

Status shows whether the journal entry has been transferred to an accounting system. The possible values are No, Processing, Yes, Error, Ignore.

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

The Z-Finance Override Transferred to Accounting permission is required to change transferredToAccounting from Yes to any other value. See Z-Finance Roles for more information.

notes

optional

Additional information about this record.

Character limit: 2,000

cf_txtn__c

optional

One or more optional custom fields, where n is the maximum number of custom fields allowed.

cf_pkn__c

optional

One or more optional custom fields, where n is the maximum number of custom fields allowed. 

journalEntryItems

optional

Key name that represents the list of journal entry items.

accountingCodeType

optional

Accounting code type. The accounting code types are:

  • AccountsReceivable
  • Cash
  • OtherAssets
  • CustomerCashOnAccount 
  • DeferredRevenue
  • SalesTaxPayable
  • OtherLiabilities
  • SalesRevenue 
  • SalesDiscounts
  • OtherRevenue
  • OtherEquity
  • BadDebt  
  • OtherExpenses

accountingCodeName

required

Name of the accounting code.

If the Journal Entry Item has a blank accounting code, enter the empty string (“”). 

type

required

Type of journal entry item. An enum with the value Credit or Debit.

cf_txtn__c

optional

One or more optional custom fields, where n is the maximum number of custom fields allowed.

cf_pkn__c

optional

One or more optional custom fields, where n is the maximum number of custom fields allowed. 

Response

success

Returns true if the request is successful. Otherwise, returns false.

processId

The internal process ID used to assist Zuora support. Returned only if success is false.

reasons

Information describing the reason for the result. Returned only if success is false.

code

An eight-digit numeric error code.

message

A description of the error.

Example

HTTP/JSON Request:

PUT https://api.zuora.com/rest/v1/journal-entries/JE-00000001/basic-information

{
 "transferredToAccounting": "Yes",
 "notes": "Transfer to accounting system",
 "cf_issueNumberc": "1000001",
 "journalEntryItems":[
         {  "accountingCodeName":"Accounts Receivable", 
            "type":"Credit",
            "cf_phasesc":"Phase 1"
         },
         {  "accountingCodeName":"", 
            "type":"Debit",
            "cf_phases__c":"Phase 1"
         }
  ]
}

JSON Response:

{
    "success": true
}
Last modified
12:31, 31 May 2016

Tags

This page has no custom tags.

Classifications

(not set)