Bank Transfer Attachments

The Attachment Object

A Rutter Bank Transfers Attachment represents a file that can be attached to a bank transfer. In general we provide attachments data only for attachments that have been created through our POST endpoint. However, there are some platform specific differences.

Properties

idstring

The Rutter ID of the attachment. This can be the same as the Platform ID. This ID is not guaranteed to be unique across all attachment objects for a connection.

platform_idstring

The platform specific ID of the attachment.

attached_to_idstringnullable

The Rutter ID of the entity linked to the attachment.

file_namestring

The file name of the attachment.

file_urlstring

The Rutter generated URL containing a downloadable version of the attachment.

attached_to_typestringnullable

The type of entity linked to the attachment.

created_atstring

The ISO 8601 timestamp that the attachment was created.

Note: The following platforms dont't support this field, and may return an empty string:

  • Xero
Endpoints
GET
/accounting/bank_transfers/attachments/:id
GET
/accounting/bank_transfers/:id/attachments/:attachmentId/file
GET
/accounting/bank_transfers/:id/attachments
POST
/accounting/bank_transfers/:id/attachments

Fetch a Bank Transfer Attachment

GEThttps://production.rutterapi.com/versioned/accounting/bank_transfers/attachments/:id

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the attachment.

    access_tokenstringqueryRequired

    The access token of the connection.

    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

Support by integration
  • QuickBooks
    QuickBooks

Download a Bank Transfers Attachment

GEThttps://production.rutterapi.com/versioned/accounting/bank_transfers/:id/attachments/:attachmentId/file

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object that has the attachment.

    attachmentIdstringpathRequired

    The platform unique ID of the attachment.

    access_tokenstringqueryRequired

    The access token of the connection.

    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

Support by integration
  • QuickBooks
    QuickBooks

List Attachments for a Bank Transfer

GEThttps://production.rutterapi.com/versioned/accounting/bank_transfers/:id/attachments

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object that has the attachment.

    access_tokenstringqueryRequired

    The access token of the connection.

    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

Support by integration
  • QuickBooks
    QuickBooks
200
Example Response Body
JSON
1
{


2
  "attachments": [


3
    {


4
      "id": "00000000-0000-0000-0000-000000000000",


5
      "platform_id": "12345678",


6
      "attached_to_id": "00000000-0000-0000-0000-000000000000",


7
      "file_name": "attachment.pdf",


8
      "file_url": "/accounting/bank_transfers/00000000-0000-0000-0000-000000000000/attachments/00000000-0000-0000-0000-000000000000/file",


9
      "attached_to_type": "BANK_TRANSFER",


10
      "created_at": "2023-01-02T02:34:56.000Z"


11
    }


12
  ]


13
}

Create a Bank Transfer Attachment

POSThttps://production.rutterapi.com/versioned/accounting/bank_transfers/:id/attachments

For this endpoint, the request body is not application/json, it is multipart/form-data.

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the underlying entity type.

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    filestring

    The file content (PDF, JPG, CSV, TXT, etc).

    file_namestring

    The file name of the attachment.

    response_modeenumOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.

Response Body

Support by integration
  • QuickBooks
    QuickBooks
Example Request Body
JSON
1
{


2
  "file": "multipart/form-data",


3
  "file_name": "T-shirt Receipt"


4
}
200
Example Response Body
JSON
1
{


2
  "attachment": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "attached_to_id": "00000000-0000-0000-0000-000000000000",


6
    "file_name": "receipt.jpg",


7
    "file_url": "https://rutteraccountingattachments.s3.amazonaws.com/00000000-0000-0000-0000-000000000000-receipt.jpg",


8
    "attached_to_type": "EXPENSE",


9
    "created_at": "2023-01-02T02:34:56.000Z"


10
  }


11
}

Have questions?

Contact support for personalized guidance.

Contact support
Next
Classes