Bank
Bank Transactions

POST /bankTransactions

Changed on

Posts an individual bank transaction to an accounting service provider for a business.

Request

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

Request body

Example request

{
  "connection": {
    "businessName": "Railz",
    "serviceName": "xero"
  },
  "data": {
    "currency": "CAD",
    "transactionType": "payment",
    "customerRef": "6d42f03b-181f-43e3-93fb-2025c012de92",
    "vendorRef": "6d42f03b-181f-43e3-93fb-2025c012de92",
    "bankAccountRef": "090",
    "lines": [
      {
        "description": "Services rendered.",
        "accountRef": "200",
        "taxRef": "45",
        "memo": "Example memo."
      }
    ],
    "date": "2021-03-29"
  }
}

Response

businessNamestring required
serviceName'quickbooks' | 'xero' | 'freshbooks' | 'quickbooksDesktop' | 'sageIntacct' | 'sageBusinessCloud' | 'oracleNetsuite' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'zohoBooks' | 'myob' required

Example response

{
  "businessName": "Railz",
  "serviceName": "xero",
  "data": {
    "currency": "CAD",
    "transactionType": "payment",
    "customerRef": "6d42f03b-181f-43e3-93fb-2025c012de92",
    "vendorRef": "6d42f03b-181f-43e3-93fb-2025c012de92",
    "bankAccountRef": "090",
    "lines": [
      {
        "description": "Services rendered.",
        "accountRef": "200",
        "taxRef": "45",
        "memo": "Example memo."
      }
    ],
    "date": "2021-03-29"
  }
}

Changes

    • info

      api tag Bank added

    • breaking

      removed the enum value overPayment of the request property /

    • breaking

      the / request property format changed from date-time to date

    • breaking

      the response's property format changed from uuid to no format for 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 dynamics365Finance enum value to the response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the response property for the response status

    • warning

      added the new freshbooks enum value to the response property for the response status

    • warning

      added the new myob enum value to the response property for the response status

    • warning

      added the new oracleNetsuite enum value to the response property for the response status

    • warning

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

    • warning

      added the new quickbooks enum value to the response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the response property for the response status

    • warning

      added the new sageIntacct enum value to the response property for the response status

    • warning

      added the new wave enum value to the response property for the response status

    • warning

      added the new xero enum value to the response property for the response status

    • warning

      added the new zohoBooks enum value to the response property for the response status

    • info

      request property / deprecated

    • info

      request property /// deprecated

    • info

      request property /// deprecated

    • info

      request property /// deprecated

    • info

      request property / deprecated

    • info

      added the new overpayment enum value to the request property /

    • info

      the / request property format was generalized from uuid to no format

    • info

      response property data/allOf[PushBankTransaction]/customerRef deprecated

    • info

      response property data/allOf[PushBankTransaction]/lines/items/memo deprecated

    • info

      response property data/allOf[PushBankTransaction]/lines/items/subTotal deprecated

    • info

      response property data/allOf[PushBankTransaction]/lines/items/totalAmount deprecated

    • info

      response property data/allOf[PushBankTransaction]/vendorRef deprecated

    • info

      removed the overPayment enum value from the ///// response property for the response status