Accounting

Journal Entries
Get API Keys

The JournalEntry object

A Rutter Journal Entry represents the atomic transaction used in any accounting system. It must contain at least one credit and debit, and the sum of credit and debit amounts must equal 0.

Files can be attached to Rutter Journal Entries in the form of Rutter Attachments.

Properties

idstring

The Rutter generated unique ID of the journal entry.

platform_idstring

The platform specific ID of the journal entry.

subsidiary_idstringnullable

The Rutter ID of the Subsidiary linked to the journal entry. This feature is currently only supported on NetSuite.

transaction_datestring

The ISO 8601 timestamp for when the journal entry was issued.

currency_codeenumnullable

The ISO 4217 currency code of the journal entry.

One ofAED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYR, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LVL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYI, UYU, UYW, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, ZAR, or ZMW.
currency_ratenumberoptional

The exchange rate between the currency of the journal entry and the business default currency.

depositedbooleannullable

If the journal entry debits the 'Undeposited Funds' account, this field will show whether the journal entry has been deposited (usually in another Bank Deposit transaction). Null if the journal entry doesn't debit the 'Undeposited Funds' account or if the platform does not support this field.

memostringnullable

The memo of the journal entry.

line_itemsarray
Show line_items attributes
created_atstringnullable

The ISO 8601 timestamp that the journal entry was created.

updated_atstringnullable

The ISO 8601 timestamp that the journal entry was last updated.

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes
Example JournalEntry Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "subsidiary_id": "00000000-0000-0000-0000-000000000000",
  "transaction_date": "2023-01-02T02:34:56.000Z",
  "currency_code": "USD",
  "currency_rate": 1,
  "deposited": true,
  "memo": "For goods sold.",
  "line_items": [
    {
      "account_id": "00000000-0000-0000-0000-000000000000",
      "tax_rate_id": "123",
      "total_amount": 12.34,
      "description": "Debit amount for goods sold"
    },
    {
      "account_id": "00000000-0000-0000-0000-000000000000",
      "tax_rate_id": "123",
      "total_amount": -12.34,
      "description": "Credit amount for goods sold"
    }
  ],
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z",
  "platform_data": {
    "id": 123,
    "data": "Varies by platform"
  }
}

List Journal Entries

GET /accounting/journal_entries
Supported for: NetSuiteQuickBooksQuickBooks DesktopSage IntacctXero

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

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

    updated_at_minintegeroptionalquery

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

Response Body

    connectionobject
    Show connection attributes
    journal_entriesarray
    Show journal_entries attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "journal_entries": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "subsidiary_id": "00000000-0000-0000-0000-000000000000",
      "transaction_date": "2023-01-02T02:34:56.000Z",
      "currency_code": "USD",
      "currency_rate": 1,
      "deposited": true,
      "memo": "For goods sold.",
      "line_items": [
        {
          "account_id": "00000000-0000-0000-0000-000000000000",
          "tax_rate_id": "123",
          "total_amount": 12.34,
          "description": "Debit amount for goods sold"
        },
        {
          "account_id": "00000000-0000-0000-0000-000000000000",
          "tax_rate_id": "123",
          "total_amount": -12.34,
          "description": "Credit amount for goods sold"
        }
      ],
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "platform_data": {
        "id": 123,
        "data": "Varies by platform"
      }
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}

Fetch a Journal Entry

GET /accounting/journal_entries/:id
Supported for: NetSuiteQuickBooksQuickBooks DesktopSage IntacctXero

Request Parameters

    idstringpath

    The Rutter generated unique ID of the object.

    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

    connectionobject
    Show connection attributes
    journal_entryobject
    Show journal_entry attributes
Example Response Body
{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "journal_entry": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
    "transaction_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "currency_rate": 1,
    "deposited": true,
    "memo": "For goods sold.",
    "line_items": [
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "tax_rate_id": "123",
        "total_amount": 12.34,
        "description": "Debit amount for goods sold"
      },
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "tax_rate_id": "123",
        "total_amount": -12.34,
        "description": "Credit amount for goods sold"
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}

Create a Journal Entry

POST /accounting/journal_entries
Supported for: Dynamics 365NetSuiteQuickBooksQuickBooks DesktopSage IntacctXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Request Body

    journal_entryobject
    Show journal_entry attributes

Response Body

    Any of:

    journal_entryobject
    Show journal_entry attributes
    async_responseobjectoptional
    Show async_response attributes
    errorsarrayoptional
    Show errors attributes
Example Request Body
{
  "journal_entry": {
    "transaction_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "memo": "For goods sold.",
    "line_items": [
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "total_amount": 12.34,
        "description": "Debit amount for goods sold."
      },
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "total_amount": 12.34,
        "description": "Credit amount for goods sold."
      }
    ]
  }
}
Example Response Body
{
  "journal_entry": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
    "transaction_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "currency_rate": 1,
    "deposited": true,
    "memo": "For goods sold.",
    "line_items": [
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "tax_rate_id": "123",
        "total_amount": 12.34,
        "description": "Debit amount for goods sold"
      },
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "tax_rate_id": "123",
        "total_amount": -12.34,
        "description": "Credit amount for goods sold"
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}
Next
Journal Entry Attachments