Accounting

Journal Entries
Get API Keys

The Journal Entry 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.

Properties

idstring

The Rutter generated unique ID of the journal entry.

platform_idstring

The platform specific ID of the journal entry.

memostringnullable

The memo of the journal entry.

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_dataoptional

The raw platform data corresponding to the Rutter object.

currencyenumnullable
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, 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_ratestringnullable

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

line_itemsarray
Show line_items attributes
issue_datestring

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

Example JournalEntry Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "currency": "USD",
  "currency_rate": "1",
  "line_items": [
    {
      "platform_id": "12345678",
      "description": "Debit amount for goods sold",
      "amount": 12.34,
      "tax_amount": 1.23,
      "account_ref": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Expenses"
      },
      "tax_rate_id": "123"
    },
    {
      "platform_id": "12345678",
      "description": "Credit amount for goods sold",
      "amount": -12.34,
      "tax_amount": 0,
      "account_ref": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Cash"
      },
      "tax_rate_id": "123"
    }
  ],
  "memo": "For goods sold.",
  "issue_date": "2023-01-02T02:34:56.000Z",
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z"
}

List Journal Entries

GET /accounting/journal_entries
Supported for: NetSuiteQuickBooksQuickBooks DesktopSage Intacct

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

    connectionConnection
    Show connection attributes
    journal_entriesarray
    Show journal_entries attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "journal_entries": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "currency": "USD",
      "currency_rate": "1",
      "line_items": [
        {
          "platform_id": "12345678",
          "description": "Debit amount for goods sold",
          "amount": 12.34,
          "tax_amount": 1.23,
          "account_ref": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "Expenses"
          },
          "tax_rate_id": "123"
        },
        {
          "platform_id": "12345678",
          "description": "Credit amount for goods sold",
          "amount": -12.34,
          "tax_amount": 0,
          "account_ref": {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "Cash"
          },
          "tax_rate_id": "123"
        }
      ],
      "memo": "For goods sold.",
      "issue_date": "2023-01-02T02:34:56.000Z",
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z"
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE",
    "orgId": "00000000-0000-0000-0000-000000000000"
  }
}

Fetch a Journal Entry

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

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

    connectionConnection
    Show connection attributes
    journal_entryJournal Entry
    Show journal_entry attributes
Example Response Body
{
  "journal_entry": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "currency": "USD",
    "currency_rate": "1",
    "line_items": [
      {
        "platform_id": "12345678",
        "description": "Debit amount for goods sold",
        "amount": 12.34,
        "tax_amount": 1.23,
        "account_ref": {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Expenses"
        },
        "tax_rate_id": "123"
      },
      {
        "platform_id": "12345678",
        "description": "Credit amount for goods sold",
        "amount": -12.34,
        "tax_amount": 0,
        "account_ref": {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Cash"
        },
        "tax_rate_id": "123"
      }
    ],
    "memo": "For goods sold.",
    "issue_date": "2023-01-02T02:34:56.000Z",
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z"
  },
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE",
    "orgId": "00000000-0000-0000-0000-000000000000"
  }
}

Create a Journal Entry

POST /accounting/journal_entries
Supported for: NetSuiteQuickBooksQuickBooks DesktopSage IntacctXero

Request Parameters

    access_tokenstringquery

    The access token of the connection.

Request Body

    journal_entryCreate Journal Entry
    Show journal_entry attributes

Response Body

    Any of:

    Journal Entry Response

    journal_entryJournal Entry
    Show journal_entry attributes

    Async Response Payload

    async_responseobjectoptional
    Show async_response attributes
    errorsarrayoptional
    Show errors attributes
Example Request Body
{
  "journal_entry": {
    "created_at": "2023-01-02T02:34:56.000Z",
    "memo": "For goods sold.",
    "currency_code": "USD",
    "line_items": [
      {
        "description": "Debit amount for goods sold.",
        "amount": 12.34,
        "account_id": "00000000-0000-0000-0000-000000000000"
      },
      {
        "description": "Credit amount for goods sold.",
        "amount": 12.34,
        "account_id": "00000000-0000-0000-0000-000000000000"
      }
    ]
  }
}
Example Response Body
{
  "journal_entry": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "currency": "USD",
    "currency_rate": "1",
    "line_items": [
      {
        "platform_id": "12345678",
        "description": "Debit amount for goods sold",
        "amount": 12.34,
        "tax_amount": 1.23,
        "account_ref": {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Expenses"
        },
        "tax_rate_id": "123"
      },
      {
        "platform_id": "12345678",
        "description": "Credit amount for goods sold",
        "amount": -12.34,
        "tax_amount": 0,
        "account_ref": {
          "id": "00000000-0000-0000-0000-000000000000",
          "name": "Cash"
        },
        "tax_rate_id": "123"
      }
    ],
    "memo": "For goods sold.",
    "issue_date": "2023-01-02T02:34:56.000Z",
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z"
  }
}
Next
Tax Rates