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.
Vision
PUT https://rest.zuora.com/v1/journal-entries/{je-number}/basic-informationPUT https://rest.apisandbox.zuora.com/v1/journal-entries/{je-number}/basic-informationThe Accept request header is optional. Only JSON is returned.
| je-number | required | path | Journal entry number in the format JE-00000001.
|
| 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.
|
| success | Returns | ||||
| processId | The internal process ID used to assist Zuora support. Returned only if success is | ||||
| reasons | Information describing the reason for the result. Returned only if success is
|
HTTP/JSON Request:
PUT https://rest.zuora.com/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
}