Journal Entries

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. Supported for NetSuite.

issue_datestring

The ISO 8601 timestamp for the issue date of the journal entry.

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, SVC, 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, ZMW, or null.
currency_ratestringnullable

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

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_atstringfilterablenullable

The ISO 8601 timestamp that the journal entry was created.

updated_atstringfilterablenullable

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

last_synced_atstringfilterable

The ISO 8601 timestamp when the journal entry was last synced by Rutter.

platform_urlstringnullable

A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints
GET
/accounting/journal_entries
GET
/accounting/journal_entries/:id
POST
/accounting/journal_entries
PATCH
/accounting/journal_entries/:id
DELETE
/accounting/journal_entries/:id

List Journal Entries

GEThttps://production.rutterapi.com/versioned/accounting/journal_entries

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringqueryOptional

    Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

    limitintegerqueryOptional

    Used to limit the number of returned objects. Defaults to 50.

    filterstringqueryOptional

    Not currently supported on Sage Intacct or Sage Business Cloud. Used to specify a filtering criteria for response objects. Refer to Filtering Objects to understand the syntax for the filtering criteria. The filtering syntax only supports fields decorated with a filterable tag in the response object.

    Filterable fields: created_at, updated_at, last_synced_at.

    sortstringqueryOptional

    Used to sort the response objects, e.g. last_synced_at ASC. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC. Supports only fields decorated with a filterable tag in the response object except on Sage Intacct and Dynamics 365 Business Central. For those platforms, only updated_at_min, updated_at_max and last_synced_at_min fields are supported and not deprecated.

    Sortable fields: created_at, updated_at, last_synced_at.

    expandenumqueryOptional

    Include platform specific data (includes additional fields not provided by the Rutter object).

    Must beplatform_data.
    last_synced_at_minintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_maxintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_minintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

Support by integration
  • QuickBooks
    QuickBooks
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
  • NetSuite
    NetSuite
200
Example Response Body
JSON
1
{


2
  "journal_entries": [


3
    {


4
      "id": "00000000-0000-0000-0000-000000000000",


5
      "platform_id": "12345678",


6
      "subsidiary_id": "00000000-0000-0000-0000-000000000000",


7
      "issue_date": "2023-01-02T02:34:56.000Z",


8
      "currency": "USD",


9
      "currency_rate": "1",


10
      "deposited": true,


11
      "memo": "For goods sold.",


12
      "line_items": [


13
        {


14
          "platform_id": "12345678",


15
          "tax_rate_id": "123",


16
          "amount": 12.34,


17
          "description": "Debit amount for goods sold",


18
          "tax_amount": 1.23,


19
          "account_ref": {


20
            "id": "00000000-0000-0000-0000-000000000000",


21
            "name": "Expenses"


22
          }


23
        },


24
        {


25
          "platform_id": "12345678",


26
          "tax_rate_id": "123",


27
          "amount": -12.34,


28
          "description": "Credit amount for goods sold",


29
          "tax_amount": 0,


30
          "account_ref": {


31
            "id": "00000000-0000-0000-0000-000000000000",


32
            "name": "Cash"


33
          }


34
        }


35
      ],


36
      "created_at": "2023-01-02T02:34:56.000Z",


37
      "updated_at": "2023-01-02T02:34:56.000Z",


38
      "last_synced_at": "2023-01-02T02:34:56.000Z",


39
      "platform_url": "https://platform.com/resource?id=123",


40
      "platform_data": {


41
        "id": 123,


42
        "data": "Varies by platform"


43
      }


44
    }


45
  ],


46
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",


47
  "connection": {


48
    "id": "00000000-0000-0000-0000-000000000000",


49
    "orgId": "00000000-0000-0000-0000-000000000000",


50
    "platform": "NETSUITE"


51
  }


52
}

Fetch a Journal Entry

GEThttps://production.rutterapi.com/versioned/accounting/journal_entries/:id

Request Parameters

    idstringpathRequired

    The unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    id_typeenumqueryOptional

    Used to indicate the type of id that is supplied. Defaults to rutter. Not currently supported on Sage Intacct or Sage Business Cloud.

    One ofrutter or platform.
    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

Support by integration
  • QuickBooks
    QuickBooks
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
  • NetSuite
    NetSuite
200
Example Response Body
JSON
1
{


2
  "journal_entry": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",


6
    "issue_date": "2023-01-02T02:34:56.000Z",


7
    "currency": "USD",


8
    "currency_rate": "1",


9
    "deposited": true,


10
    "memo": "For goods sold.",


11
    "line_items": [


12
      {


13
        "platform_id": "12345678",


14
        "tax_rate_id": "123",


15
        "amount": 12.34,


16
        "description": "Debit amount for goods sold",


17
        "tax_amount": 1.23,


18
        "account_ref": {


19
          "id": "00000000-0000-0000-0000-000000000000",


20
          "name": "Expenses"


21
        }


22
      },


23
      {


24
        "platform_id": "12345678",


25
        "tax_rate_id": "123",


26
        "amount": -12.34,


27
        "description": "Credit amount for goods sold",


28
        "tax_amount": 0,


29
        "account_ref": {


30
          "id": "00000000-0000-0000-0000-000000000000",


31
          "name": "Cash"


32
        }


33
      }


34
    ],


35
    "created_at": "2023-01-02T02:34:56.000Z",


36
    "updated_at": "2023-01-02T02:34:56.000Z",


37
    "last_synced_at": "2023-01-02T02:34:56.000Z",


38
    "platform_url": "https://platform.com/resource?id=123",


39
    "platform_data": {


40
      "id": 123,


41
      "data": "Varies by platform"


42
    }


43
  },


44
  "connection": {


45
    "id": "00000000-0000-0000-0000-000000000000",


46
    "orgId": "00000000-0000-0000-0000-000000000000",


47
    "platform": "NETSUITE"


48
  }


49
}

Create a Journal Entry

POSThttps://production.rutterapi.com/versioned/accounting/journal_entries

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    response_modeenumOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.
    journal_entryobject
    Show journal_entry attributes

Response Body

Support by integration
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
  • NetSuite
    NetSuite
Example Request Body
JSON
1
{


2
  "journal_entry": {


3
    "currency_code": "USD",


4
    "memo": "For goods sold.",


5
    "line_items": [


6
      {


7
        "account_id": "00000000-0000-0000-0000-000000000000",


8
        "amount": 12.34,


9
        "description": "Debit amount for goods sold."


10
      },


11
      {


12
        "account_id": "00000000-0000-0000-0000-000000000000",


13
        "amount": 12.34,


14
        "description": "Credit amount for goods sold."


15
      }


16
    ],


17
    "created_at": "2023-01-02T02:34:56.000Z"


18
  }


19
}
200
Example Response Body
JSON
1
{


2
  "journal_entry": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",


6
    "issue_date": "2023-01-02T02:34:56.000Z",


7
    "currency": "USD",


8
    "currency_rate": "1",


9
    "deposited": true,


10
    "memo": "For goods sold.",


11
    "line_items": [


12
      {


13
        "platform_id": "12345678",


14
        "tax_rate_id": "123",


15
        "amount": 12.34,


16
        "description": "Debit amount for goods sold",


17
        "tax_amount": 1.23,


18
        "account_ref": {


19
          "id": "00000000-0000-0000-0000-000000000000",


20
          "name": "Expenses"


21
        }


22
      },


23
      {


24
        "platform_id": "12345678",


25
        "tax_rate_id": "123",


26
        "amount": -12.34,


27
        "description": "Credit amount for goods sold",


28
        "tax_amount": 0,


29
        "account_ref": {


30
          "id": "00000000-0000-0000-0000-000000000000",


31
          "name": "Cash"


32
        }


33
      }


34
    ],


35
    "created_at": "2023-01-02T02:34:56.000Z",


36
    "updated_at": "2023-01-02T02:34:56.000Z",


37
    "last_synced_at": "2023-01-02T02:34:56.000Z",


38
    "platform_url": "https://platform.com/resource?id=123",


39
    "platform_data": {


40
      "id": 123,


41
      "data": "Varies by platform"


42
    }


43
  }


44
}

Update a Journal Entry

PATCHhttps://production.rutterapi.com/versioned/accounting/journal_entries/:id

If a field value is provided, that field will take the updated value. If the field is not provided, the existing value will persist. Note: PATCH /journal_entries not yet supported for Netsuite Advanced Intercompany Journal Entries.

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    response_modeenumOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.
    journal_entryobject
    Show journal_entry attributes

Response Body

Support by integration
  • NetSuite
    NetSuite
Example Request Body
JSON
1
{


2
  "journal_entry": {


3
    "transaction_date": "2023-01-02T02:34:56.000Z",


4
    "currency_code": "USD",


5
    "currency_rate": 1,


6
    "memo": "For goods sold.",


7
    "line_items": [


8
      {


9
        "account_id": "00000000-0000-0000-0000-000000000000",


10
        "total_amount": 12.34,


11
        "description": "Debit amount for goods sold."


12
      },


13
      {


14
        "account_id": "00000000-0000-0000-0000-000000000000",


15
        "total_amount": -12.34,


16
        "description": "Credit amount for goods sold."


17
      }


18
    ]


19
  }


20
}
200
Example Response Body
JSON
1
{


2
  "journal_entry": {


3
    "id": "00000000-0000-0000-0000-000000000000",


4
    "platform_id": "12345678",


5
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",


6
    "issue_date": "2023-01-02T02:34:56.000Z",


7
    "currency": "USD",


8
    "currency_rate": "1",


9
    "deposited": true,


10
    "memo": "For goods sold.",


11
    "line_items": [


12
      {


13
        "platform_id": "12345678",


14
        "tax_rate_id": "123",


15
        "amount": 12.34,


16
        "description": "Debit amount for goods sold",


17
        "tax_amount": 1.23,


18
        "account_ref": {


19
          "id": "00000000-0000-0000-0000-000000000000",


20
          "name": "Expenses"


21
        }


22
      },


23
      {


24
        "platform_id": "12345678",


25
        "tax_rate_id": "123",


26
        "amount": -12.34,


27
        "description": "Credit amount for goods sold",


28
        "tax_amount": 0,


29
        "account_ref": {


30
          "id": "00000000-0000-0000-0000-000000000000",


31
          "name": "Cash"


32
        }


33
      }


34
    ],


35
    "created_at": "2023-01-02T02:34:56.000Z",


36
    "updated_at": "2023-01-02T02:34:56.000Z",


37
    "last_synced_at": "2023-01-02T02:34:56.000Z",


38
    "platform_url": "https://platform.com/resource?id=123",


39
    "platform_data": {


40
      "id": 123,


41
      "data": "Varies by platform"


42
    }


43
  }


44
}

Delete a Journal Entry

DELETEhttps://production.rutterapi.com/versioned/accounting/journal_entries/:id

Request Parameters

    idstringpathRequired

    The Rutter generated unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    response_modeenumOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.

Response Body

Support by integration
  • QuickBooks
    QuickBooks
200
Example Response Body
JSON
1
{


2
  "code": "deleted",


3
  "success": true


4
}

Have questions?

Contact support for personalized guidance.

Contact support
Previous
Items
Next
Journal Entry Attachments