Skip to content
/Attachments

Upload an attachment

Request

Purpose

Attaches a supporting file (for example a calculation workbook or approval email) to a journal entry, optionally with a note and a link. Files up to 100 MB are accepted.

When to use

  • Attach supporting evidence (calculation workbook, approval email, contract) or a note/link to an entry, typically before submitting it for approval.
Security
OneIdOAuth
Path
jeIdinteger, (int64)required

ID of the journal entry.

Example:10045
Query
bookIdinteger, (int32)required

Accounting book ID of the journal entry.

Example:bookId=1
commentsstring

Note stored with the attachment.

Example:comments=Supporting calculation
Bodymultipart/form-datarequired
filestring or null, (binary)

File to attach (up to 100 MB).

{
  "file": "(binary content of support.xlsx)"
}

Responses

Attachment uploaded

Headers
traceIdstring

Identifier of the request. Quote it when you contact Zuora Support.

Bodyapplication/json
statusstring or null

success or failure.

Enum:"success""failure"
Example:"success"
messagestring or null

Result message.

Example:"Notes/Attachments are successfully uploaded"
Response
{
  "status": "success",
  "message": "Notes/Attachments are successfully uploaded"
}