Expenses - Rutter API Reference - the Common Language for Business Data

The Expense object

A Rutter Expense represents a purchase made by a business entity via prepaid card, credit card, bank, or other asset. Every expense is linked to a credit Account and a Vendor.

The expense line item contains information regarding the items purchased and accounts affected in the expense. Every expense line item is linked to a debit Account and optionally linked tracking categories like Classes, Locations, and Departments.

Properties

idstring

The Rutter generated unique ID of the expense.

platform_idstring

The platform specific ID of the expense.

vendor_idstringnullable

The Rutter ID of the Vendor linked to the expense.

memostringnullable

The memo of the expense.

created_atstringnullable

The ISO 8601 timestamp that the expense was created.

updated_atstringnullable

The ISO 8601 timestamp that the expense was last updated.

platform_dataoptional

The raw platform data corresponding to the Rutter object.

account_idstring

The Rutter ID of the Account linked to the expense. Represents the account being credited.

currency_codeenumnullableoptional

The ISO 4217 currency code of the expense.

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.

expense_datestringnullable

The ISO 8601 timestamp that the expense was created.

line_itemsarray

An array of line items associated with the expense.

Show line_items attributes

Example Expense Object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "account_id": "00000000-0000-0000-0000-000000000000",
  "vendor_id": "00000000-0000-0000-0000-000000000000",
  "currency_code": "USD",
  "expense_date": "2023-01-02T02:34:56.000Z",
  "memo": "For a Rutter shirt.",
  "line_items": [
    {
      "account_id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "amount": "12.34",
      "description": "Rutter shirt",
      "class_id": "00000000-0000-0000-0000-000000000000",
      "location_id": "00000000-0000-0000-0000-000000000000",
      "department_id": "00000000-0000-0000-0000-000000000000",
      "customer_id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z"
}

List Expenses

GET /accounting/expenses

Supported for: Dynamics 365NetSuiteQuickBooksQuickBooks DesktopXeroZoho Books

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

expensesarray

Show expenses attributes

next_cursorstringnullableoptional

Example Response Body

{
  "expenses": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "vendor_id": "00000000-0000-0000-0000-000000000000",
      "currency_code": "USD",
      "expense_date": "2023-01-02T02:34:56.000Z",
      "memo": "For a Rutter shirt.",
      "line_items": [
        {
          "account_id": "00000000-0000-0000-0000-000000000000",
          "platform_id": "12345678",
          "amount": "12.34",
          "description": "Rutter shirt",
          "class_id": "00000000-0000-0000-0000-000000000000",
          "location_id": "00000000-0000-0000-0000-000000000000",
          "department_id": "00000000-0000-0000-0000-000000000000",
          "customer_id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "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 an Expense

GET /accounting/expenses/:id

Supported for: Dynamics 365NetSuiteQuickBooksQuickBooks DesktopXeroZoho Books

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

expenseExpense

Show expense attributes

Example Response Body

{
  "expense": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "vendor_id": "00000000-0000-0000-0000-000000000000",
    "currency_code": "USD",
    "expense_date": "2023-01-02T02:34:56.000Z",
    "memo": "For a Rutter shirt.",
    "line_items": [
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "platform_id": "12345678",
        "amount": "12.34",
        "description": "Rutter shirt",
        "class_id": "00000000-0000-0000-0000-000000000000",
        "location_id": "00000000-0000-0000-0000-000000000000",
        "department_id": "00000000-0000-0000-0000-000000000000",
        "customer_id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "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 an Expense

POST /accounting/expenses

Supported for: Dynamics 365NetSuiteQuickBooksQuickBooks DesktopXeroZoho Books

Request Parameters

access_tokenstringquery

The access token of the connection.

Request Body

expenseobject

Show expense attributes

Response Body

Any of:

Expense Response

expenseExpense

Show expense attributes

Async Response Payload

async_responseobjectoptional

Show async_response attributes

errorsarrayoptional

Show errors attributes

Example Request Body

{
  "expense": {
    "account_id": "00000000-0000-0000-0000-000000000000",
    "currency_code": "USD",
    "expense_date": "2023-01-02T02:34:56.000Z",
    "vendor_id": "00000000-0000-0000-0000-000000000000",
    "memo": "For a Rutter shirt.",
    "line_items": [
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "amount": 12.34,
        "description": "For a Rutter shirt.",
        "class_id": "00000000-0000-0000-0000-000000000000",
        "department_id": "00000000-0000-0000-0000-000000000000",
        "location_id": "00000000-0000-0000-0000-000000000000",
        "customer_id": "00000000-0000-0000-0000-000000000000"
      }
    ]
  }
}

Example Response Body

{
  "expense": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "vendor_id": "00000000-0000-0000-0000-000000000000",
    "currency_code": "USD",
    "expense_date": "2023-01-02T02:34:56.000Z",
    "memo": "For a Rutter shirt.",
    "line_items": [
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "platform_id": "12345678",
        "amount": "12.34",
        "description": "Rutter shirt",
        "class_id": "00000000-0000-0000-0000-000000000000",
        "location_id": "00000000-0000-0000-0000-000000000000",
        "department_id": "00000000-0000-0000-0000-000000000000",
        "customer_id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z"
  }
}

Create an Expense Refund

POST /accounting/expenses/refunds

Supported for: Dynamics 365NetSuiteQuickBooksQuickBooks DesktopXeroZoho Books

Request Parameters

access_tokenstringquery

The access token of the connection.

Request Body

expense_refundobject

Show expense_refund attributes

Response Body

Any of:

Expense Refund Response

expense_refundExpense Refund

Show expense_refund attributes

Async Response Payload

async_responseobjectoptional

Show async_response attributes

errorsarrayoptional

Show errors attributes

Example Request Body

{
  "expense_refund": {
    "amount": 12.34,
    "expense_account_id": "00000000-0000-0000-0000-000000000000",
    "debit_account_id": "00000000-0000-0000-0000-000000000000",
    "description": "Refund for a Rutter shirt.",
    "expense_date": "2023-01-02T02:34:56.000Z",
    "vendor_id": "00000000-0000-0000-0000-000000000000",
    "currency_code": "USD"
  }
}

Example Response Body

{
  "expense_refund": {
    "id": "00000000-0000-0000-0000-000000000000",
    "amount": 12.34,
    "expense_account_id": "00000000-0000-0000-0000-000000000000",
    "debit_account_id": "00000000-0000-0000-0000-000000000000",
    "description": "Refund for a Rutter shirt.",
    "vendor_id": "00000000-0000-0000-0000-000000000000",
    "currency": "USD"
  }
}