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

The Bill object

A Rutter Bill represents a bill issued by a vendor that the business entity must pay. Every expense is linked to an accounts payable Account, a Vendor, Purchase Orders, Bill Payments, and Bill Credit Memos.

The bill line item contains information regarding the items purchased and accounts affected in the bill. Every bill line item is linked to a debit Account, Tax Rate, and Item.

Properties

idstring

The Rutter generated unique ID of the bill.

platform_idstring

The platform specific ID of the bill.

memostringnullable

Memo or description of the bill

document_numberstringnullable

The buyer facing document number of the bill.

account_idstringoptional

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

vendor_idstringnullable

The Rutter ID of the Vendor linked to the bill.

issue_datestring

The ISO 8601 timestamp for the issue date of the bill..

due_datestring

The ISO 8601 timestamp of the due date of the bill.

statusenum

The status of the bill.

One ofopen, partially_paid, paid, void, draft, unknown, or submitted.

total_discountstringnullable

The total amount of discounts applied to the bill.

sub_totalstringnullable

The subtotal of the bill, without the tax amount.

tax_amountstringnullable

The total tax amount applied to the bill.

total_amountstring

The total amount due on the bill.

amount_duestring

The current amount due on the bill. Represents the remainder after bill payments or bill credit memos are applied against the total amount.

created_atstringnullable

updated_atstringnullable

currencyenum

The ISO 4217 currency code of the bill.

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.

paymentsarray

An array of Rutter IDs of Bill Payments and Bill Credit Memos applied against the bill.

Show payments attributes

purchase_ordersarray

An array of Rutter IDs of Purchase Orders linked to the bill.

Show purchase_orders attributes

line_itemsarray

An array of line items associated with the bill.

Show line_items attributes

Example Bill Object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "document_number": "VENDBILL-1",
  "account_id": "00000000-0000-0000-0000-000000000000",
  "vendor_id": "00000000-0000-0000-0000-000000000000",
  "memo": "Bill description",
  "purchase_orders": [
    {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "issue_date": "2023-01-02T02:34:56.000Z",
  "due_date": "2023-01-02T02:34:56.000Z",
  "currency": "USD",
  "line_items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "description": "A Rutter shirt.",
      "unit_amount": "12.34",
      "quantity": "1",
      "discount_amount": "0",
      "sub_total": "12.34",
      "tax_amount": "2",
      "amount": "14.34",
      "discount_percentage": "0",
      "tax_rate_id": "00000000-0000-0000-0000-000000000000",
      "item_id": "00000000-0000-0000-0000-000000000000",
      "item": {
        "id": "00000000-0000-0000-0000-000000000000",
        "unit_amount": 12.34,
        "quantity": 1
      },
      "account_id": "00000000-0000-0000-0000-000000000000",
      "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"
    }
  ],
  "status": "partially_paid",
  "total_discount": "0",
  "sub_total": "12.34",
  "tax_amount": "2",
  "total_amount": "14.34",
  "amount_due": "9.34",
  "payments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "BILL_PAYMENT",
      "amount": "3",
      "date": "2023-01-02T02:34:56.000Z"
    },
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "BILL_CREDIT_MEMO",
      "amount": "2",
      "date": "2023-01-02T02:34:56.000Z"
    }
  ],
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z"
}

List Bills

GET /accounting/bills

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

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

billsarray

Show bills attributes

next_cursorstringnullableoptional

Example Response Body

{
  "bills": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "document_number": "VENDBILL-1",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "vendor_id": "00000000-0000-0000-0000-000000000000",
      "memo": "Bill description",
      "purchase_orders": [
        {
          "id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "issue_date": "2023-01-02T02:34:56.000Z",
      "due_date": "2023-01-02T02:34:56.000Z",
      "currency": "USD",
      "line_items": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "description": "A Rutter shirt.",
          "unit_amount": "12.34",
          "quantity": "1",
          "discount_amount": "0",
          "sub_total": "12.34",
          "tax_amount": "2",
          "amount": "14.34",
          "discount_percentage": "0",
          "tax_rate_id": "00000000-0000-0000-0000-000000000000",
          "item_id": "00000000-0000-0000-0000-000000000000",
          "item": {
            "id": "00000000-0000-0000-0000-000000000000",
            "unit_amount": 12.34,
            "quantity": 1
          },
          "account_id": "00000000-0000-0000-0000-000000000000",
          "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"
        }
      ],
      "status": "partially_paid",
      "total_discount": "0",
      "sub_total": "12.34",
      "tax_amount": "2",
      "total_amount": "14.34",
      "amount_due": "9.34",
      "payments": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "BILL_PAYMENT",
          "amount": "3",
          "date": "2023-01-02T02:34:56.000Z"
        },
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "BILL_CREDIT_MEMO",
          "amount": "2",
          "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 Bill

GET /accounting/bills/: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

connectionConnection

Show connection attributes

billBill

Show bill attributes

Example Response Body

{
  "bill": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "document_number": "VENDBILL-1",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "vendor_id": "00000000-0000-0000-0000-000000000000",
    "memo": "Bill description",
    "purchase_orders": [
      {
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "issue_date": "2023-01-02T02:34:56.000Z",
    "due_date": "2023-01-02T02:34:56.000Z",
    "currency": "USD",
    "line_items": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "description": "A Rutter shirt.",
        "unit_amount": "12.34",
        "quantity": "1",
        "discount_amount": "0",
        "sub_total": "12.34",
        "tax_amount": "2",
        "amount": "14.34",
        "discount_percentage": "0",
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
        "item_id": "00000000-0000-0000-0000-000000000000",
        "item": {
          "id": "00000000-0000-0000-0000-000000000000",
          "unit_amount": 12.34,
          "quantity": 1
        },
        "account_id": "00000000-0000-0000-0000-000000000000",
        "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"
      }
    ],
    "status": "partially_paid",
    "total_discount": "0",
    "sub_total": "12.34",
    "tax_amount": "2",
    "total_amount": "14.34",
    "amount_due": "9.34",
    "payments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "BILL_PAYMENT",
        "amount": "3",
        "date": "2023-01-02T02:34:56.000Z"
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "BILL_CREDIT_MEMO",
        "amount": "2",
        "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 Bill

POST /accounting/bills

Supported for: NetSuiteQuickBooksQuickBooks DesktopSage IntacctXero

Request Parameters

access_tokenstringquery

The access token of the connection.

Request Body

billobject

Show bill attributes

Response Body

Any of:

Bill Response

billBill

Show bill attributes

Async Response Payload

async_responseobjectoptional

Show async_response attributes

errorsarrayoptional

Show errors attributes

Example Request Body

{
  "bill": {
    "vendor_id": "00000000-0000-0000-0000-000000000000",
    "currency": "USD",
    "line_items": [
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "amount": 12.34,
        "description": "A Rutter shirt."
      }
    ],
    "due_date": "2023-01-02T02:34:56.000Z",
    "issue_date": "2023-01-02T02:34:56.000Z"
  }
}

Example Response Body

{
  "bill": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "document_number": "VENDBILL-1",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "vendor_id": "00000000-0000-0000-0000-000000000000",
    "memo": "Bill description",
    "purchase_orders": [
      {
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "issue_date": "2023-01-02T02:34:56.000Z",
    "due_date": "2023-01-02T02:34:56.000Z",
    "currency": "USD",
    "line_items": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "description": "A Rutter shirt.",
        "unit_amount": "12.34",
        "quantity": "1",
        "discount_amount": "0",
        "sub_total": "12.34",
        "tax_amount": "2",
        "amount": "14.34",
        "discount_percentage": "0",
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
        "item_id": "00000000-0000-0000-0000-000000000000",
        "item": {
          "id": "00000000-0000-0000-0000-000000000000",
          "unit_amount": 12.34,
          "quantity": 1
        },
        "account_id": "00000000-0000-0000-0000-000000000000",
        "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"
      }
    ],
    "status": "partially_paid",
    "total_discount": "0",
    "sub_total": "12.34",
    "tax_amount": "2",
    "total_amount": "14.34",
    "amount_due": "9.34",
    "payments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "BILL_PAYMENT",
        "amount": "3",
        "date": "2023-01-02T02:34:56.000Z"
      },
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "BILL_CREDIT_MEMO",
        "amount": "2",
        "date": "2023-01-02T02:34:56.000Z"
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z"
  }
}