Attachment
Attachments

GET /attachments

Changed on

Gets all invoice & bill attachments for a business.

Request

  • Base URL
    https://api.railz.ai
  • Auth
    HTTP bearer

Query parameters

businessNamestring required
serviceName'freshbooks' | 'quickbooks' | 'xero' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'zohoBooks' required
offsetnumber

The offset is the position in the dataset of a particular record.

limitnumber
Example:100

This is the size of the results set you would like (default: 100).

orderBystring
idstring

Response

countnumber required

Example response

{
  "count": 1,
  "data": [
    {
      "id": "1",
      "url": "https://api.railz.ai/Attachments/Image00394.png",
      "fileName": "image00394.png",
      "contentType": "image/jpeg",
      "uploadDate": "2020-11-25T01:02:03Z",
      "fileSize": 10495,
      "sourceModifiedDate": "2021-03-09T08:49:36.035Z",
      "link": {
        "type": "bill",
        "id": "234"
      }
    }
  ]
}

Changes

    • info

      api tag Attachment added

    • breaking

      removed the enum value myob from the query request parameter serviceName

    • breaking

      removed the enum value oracleNetsuite from the query request parameter serviceName

    • breaking

      removed the enum value plaid from the query request parameter serviceName

    • breaking

      removed the enum value quickbooksDesktop from the query request parameter serviceName

    • breaking

      removed the enum value shopify from the query request parameter serviceName

    • breaking

      removed the enum value square from the query request parameter serviceName

    • breaking

      removed the enum value wave from the query request parameter serviceName

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      added the new account enum value to the /// response property for the response status

    • warning

      added the new account enum value to the /// response property for the response status

    • warning

      added the new bankTransaction enum value to the /// response property for the response status

    • warning

      added the new bankTransaction enum value to the /// response property for the response status

    • warning

      added the new bankTransfer enum value to the /// response property for the response status

    • warning

      added the new bankTransfer enum value to the /// response property for the response status

    • warning

      added the new billCreditNote enum value to the /// response property for the response status

    • warning

      added the new billCreditNote enum value to the /// response property for the response status

    • warning

      added the new billPayment enum value to the /// response property for the response status

    • warning

      added the new billPayment enum value to the /// response property for the response status

    • warning

      added the new customer enum value to the /// response property for the response status

    • warning

      added the new customer enum value to the /// response property for the response status

    • warning

      added the new deposit enum value to the /// response property for the response status

    • warning

      added the new deposit enum value to the /// response property for the response status

    • warning

      added the new expense enum value to the /// response property for the response status

    • warning

      added the new expense enum value to the /// response property for the response status

    • warning

      added the new inventory enum value to the /// response property for the response status

    • warning

      added the new inventory enum value to the /// response property for the response status

    • warning

      added the new invoiceCreditNote enum value to the /// response property for the response status

    • warning

      added the new invoiceCreditNote enum value to the /// response property for the response status

    • warning

      added the new invoicePayment enum value to the /// response property for the response status

    • warning

      added the new invoicePayment enum value to the /// response property for the response status

    • warning

      added the new journalEntry enum value to the /// response property for the response status

    • warning

      added the new journalEntry enum value to the /// response property for the response status

    • warning

      added the new purchaseOrder enum value to the /// response property for the response status

    • warning

      added the new purchaseOrder enum value to the /// response property for the response status

    • warning

      added the new vendor enum value to the /// response property for the response status

    • warning

      added the new vendor enum value to the /// response property for the response status

    • info

      added the new enum value zohoBooks to the query request parameter serviceName