Accounting

Attachments
Get API Keys

The Attachment object

A Rutter Attachment represents a file that can be attached to other accounting entities (bills, bill payments, invoices, expenses, etc) owned by a business entity.

Properties

idstring

The Rutter generated unique ID of the attachment.

platform_idstring

The platform specific ID of the attachment.

attached_to_idstringnullable

The Rutter ID of the entity linked to the attachment.

attached_to_typestringnullable

The type of entity linked to the attachment.

file_urlstring

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

file_namestring

The file name of the attachment.

created_atstring

The ISO 8601 timestamp that the attachment was created.

Example Attachment Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "attached_to_id": "00000000-0000-0000-0000-000000000000",
  "attached_to_type": "EXPENSE",
  "file_url": "https://rutteraccountingattachments.s3.amazonaws.com/00000000-0000-0000-0000-000000000000-receipt.jpg",
  "file_name": "receipt.jpg",
  "created_at": "2023-01-02T02:34:56.000Z"
}

List Attachments

GET /accounting/:entityType/attachments
Supported for: Dynamics 365NetSuiteQuickBooksZoho Books

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    cursorstringoptionalquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    expandenumoptionalquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    limitintegeroptionalquery

    The limit on the number of entities returned.

    updated_at_maxintegeroptionalquery

    The Unix Timestamp in milliseconds maximum updated_at datetime to fetch entities from.

    updated_at_minintegeroptionalquery

    The Unix Timestamp in milliseconds minimum updated_at datetime to fetch entities from.

Response Body

    attachmentsarray
    Show attachments attributes
    next_cursorstringnullable
Example Response Body
{
  "attachments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "attached_to_id": "00000000-0000-0000-0000-000000000000",
      "attached_to_type": "EXPENSE",
      "file_url": "https://rutteraccountingattachments.s3.amazonaws.com/00000000-0000-0000-0000-000000000000-receipt.jpg",
      "file_name": "receipt.jpg",
      "created_at": "2023-01-02T02:34:56.000Z"
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}

Fetch an Attachment

GET /accounting/:entityType/attachments/:id
Supported for: Dynamics 365NetSuiteQuickBooksZoho Books

Request Parameters

    entityTypeenumpath

    The entity type of the attachment.

    One ofbills or expenses.
    idstringpath

    The Rutter generated unique ID of the attachment.

    access_tokenstringquery

    The access token of the connection.

    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.

Response Body

    attachmentAttachment
    Show attachment attributes

Create an Attachment

POST /accounting/:entityType/:id/attachments
Supported for: Dynamics 365NetSuiteQuickBooksXeroZoho Books

Request Parameters

    entityTypeenumpath

    The entity type of the attachment.

    One ofbills or expenses.
    idstringpath

    The Rutter generated unique ID of the attachment.

    access_tokenstringquery

    The access token of the connection.

Request Body

    file_namestring

    The file name of the attachment.

Response Body

    Any of:

    Attachment Response

    attachmentAttachment
    Show attachment attributes

    Async Response Payload

    async_responseobjectoptional
    Show async_response attributes
    errorsarrayoptional
    Show errors attributes
Example Request Body
{
  "file_name": "receipt.jpg"
}
Example Response Body
{
  "attachment": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "attached_to_id": "00000000-0000-0000-0000-000000000000",
    "attached_to_type": "EXPENSE",
    "file_url": "https://rutteraccountingattachments.s3.amazonaws.com/00000000-0000-0000-0000-000000000000-receipt.jpg",
    "file_name": "receipt.jpg",
    "created_at": "2023-01-02T02:34:56.000Z"
  }
}
Next
Items