Sign in

v1

latestOpenAPI 3.1.02026-08-06236494759.4 KB
Transaction Attachments

Update Transaction Attachment Metadata

Endpoint to update the TransactionAttachment Metadata of by ID.

put/business/v2/transactions/{transactionId}/attachments/{attachmentId}

Path parameters

transactionIdstring required

The Transaction ID.

Example:7bf79328-a7ae-4222-aa54-091ff7f429a7
attachmentIdstring required

The TransactionAttachment ID.

Example:2d65bd5e-3fdf-4002-b166-bde7fb8863fa

Request body

read_onlyboolean

true if the attachment is not editable

attachment_type'RECEIPT' | 'INVOICE' | 'MAIL' | 'OTHER' | 'PURCHASE_REQUEST' | 'POP_AUTH' | 'POP_SETTLEMENT'
metadataobject

Generic map of custom metadata

Response

The returned resource is a single TransactionAttachment.

attachment_idstring

The TransactionAttachment ID.

transaction_idstring

The Transaction ID the file is attached to.

file_namestring

The file name of the attachment.

file_extensionstring

The file extension of the attachment.

file_sizeinteger

The file size in bytes.

urlstring

The url of the attachment.

file_urlstring

The Base64 string of the File URL encrypted by DES in ECB mode, Pkcs7 padding scheme and using Token for key. Deprecated, use url instead.

url_type'DOWNLOAD_URL' | 'UPLOAD_URL' | 'UPLOAD_COMPLETED' | 'DELETE' | 'THUMBNAILS_DOWNLOAD_URL' | 'UPDATE_METADATA'
attachment_type'RECEIPT' | 'INVOICE' | 'MAIL' | 'OTHER' | 'PURCHASE_REQUEST' | 'POP_AUTH' | 'POP_SETTLEMENT'
read_onlyboolean

It determines whether the attachment can be removed or updated.

content_typestring

The type of the TransactionAttachment content (default: 'binary/octet-stream').

upload_timestring

The date of upload.

attachment_user_idstring

The ID of the User that uploaded the attachment.

upload_user_channel'WEB' | 'MOBILE' | 'BO_USER' | 'business' | 'BAPI' | 'PAPI' | 'OTHER'
metadataobject

The metadata of the attachment.

last_update_timestring

The date and time when the TransactionAttachment was last updated.

Example response

{
  "attachment_id": "2d65bd5e-3fdf-4002-b166-bde7fb8863fa",
  "transaction_id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
  "file_name": "invoice01.jpg",
  "file_extension": ".jpg",
  "file_size": 32768,
  "content_type": "binary/octet-stream",
  "upload_time": "2017-06-01T12:48:40Z",
  "compressed_file": {
    "file_name": "invoice01_thumb.jpg",
    "file_extension": ".jpg",
    "file_size": 32768
  },
  "last_update_time": "2017-06-01T12:48:40Z"
}