GET v1/payments/{id}/attachments

Gets list of attachments for the payment specified by payment id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Provide payment id to get attachments for

integer

Required

Body Parameters

None.

Response Information

Resource Description

SearchResultOfAttachment
NameDescriptionTypeAdditional information
TotalCount

integer

None.

Data

Collection of Attachment

None.

Response Formats

application/json, text/json

Sample:
{
  "totalCount": 1,
  "data": [
    {
      "id": 1,
      "fileName": "sample string 2",
      "originalFileName": "sample string 3",
      "filePath": "sample string 4",
      "uploadedBy": {
        "id": 1,
        "name": "sample string 2"
      },
      "visibleOnPortal": true,
      "isDefault": true,
      "dateCreated": "2022-07-01T15:41:18.6488443-04:00"
    },
    {
      "id": 1,
      "fileName": "sample string 2",
      "originalFileName": "sample string 3",
      "filePath": "sample string 4",
      "uploadedBy": {
        "id": 1,
        "name": "sample string 2"
      },
      "visibleOnPortal": true,
      "isDefault": true,
      "dateCreated": "2022-07-01T15:41:18.6488443-04:00"
    }
  ]
}

application/xml, text/xml

Sample:
<SearchResultOfAttachment3KdDVibf xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:Attachment>
      <d2p1:DateCreated>2022-07-01T15:41:18.6488443-04:00</d2p1:DateCreated>
      <d2p1:FileName>sample string 2</d2p1:FileName>
      <d2p1:FilePath>sample string 4</d2p1:FilePath>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsDefault>true</d2p1:IsDefault>
      <d2p1:OriginalFileName>sample string 3</d2p1:OriginalFileName>
      <d2p1:UploadedBy xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:UploadedBy>
      <d2p1:VisibleOnPortal>true</d2p1:VisibleOnPortal>
    </d2p1:Attachment>
    <d2p1:Attachment>
      <d2p1:DateCreated>2022-07-01T15:41:18.6488443-04:00</d2p1:DateCreated>
      <d2p1:FileName>sample string 2</d2p1:FileName>
      <d2p1:FilePath>sample string 4</d2p1:FilePath>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsDefault>true</d2p1:IsDefault>
      <d2p1:OriginalFileName>sample string 3</d2p1:OriginalFileName>
      <d2p1:UploadedBy xmlns:d4p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:UploadedBy>
      <d2p1:VisibleOnPortal>true</d2p1:VisibleOnPortal>
    </d2p1:Attachment>
  </Data>
  <TotalCount>1</TotalCount>
</SearchResultOfAttachment3KdDVibf>