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 bill 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.

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

Properties

idstring

The Rutter generated unique ID of the bill.

platform_idstring

The platform specific ID of the bill.

account_idstringnullable

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

payment_terms_idstringnullable

An array of Rutter IDs of Payment Terms linked to the bill.

subsidiary_idstringnullable

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

vendor_idstringnullable

The Rutter ID of the Vendor linked to the bill.

due_datestringnullable

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

issue_datestring

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

amount_duenumber

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

currency_codeenum

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, 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.

statusenum

The status of the bill.

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

total_amountnumber

The total amount due on the bill.

document_numberstringnullable

The buyer facing document number of the bill.

memostringnullable

Memo or description of the bill

sub_totalnumbernullable

The subtotal of the bill, without the tax amount.

tax_amountnumbernullable

The tax amount applied to the bill.

total_discountnumbernullable

The discount amount applied to the bill.

linked_purchase_ordersarray

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

Show linked_purchase_orders attributes

linked_credit_memosarray

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

Show linked_credit_memos attributes

linked_paymentsarray

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

Show linked_payments attributes

line_itemsarray

An array of line items associated with the bill.

Show line_items attributes

created_atstringnullable

The ISO 8601 timestamp that the bill was created.

updated_atstringnullable

The ISO 8601 timestamp that the bill was last updated.

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes

Example Bill Object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "account_id": "00000000-0000-0000-0000-000000000000",
  "payment_terms_id": "00000000-0000-0000-0000-000000000000",
  "subsidiary_id": "00000000-0000-0000-0000-000000000000",
  "vendor_id": "00000000-0000-0000-0000-000000000000",
  "due_date": "2023-01-02T02:34:56.000Z",
  "issue_date": "2023-01-02T02:34:56.000Z",
  "amount_due": 9.34,
  "currency_code": "USD",
  "status": "partially_paid",
  "total_amount": 14.34,
  "document_number": "VENDBILL-1",
  "memo": "Bill description",
  "sub_total": 12.34,
  "tax_amount": 2,
  "total_discount": 0,
  "linked_purchase_orders": [
    {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "linked_credit_memos": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "allocated_date": "2023-01-02T02:34:56.000Z",
      "allocated_amount": 2
    }
  ],
  "linked_payments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "allocated_date": "2023-01-02T02:34:56.000Z",
      "allocated_amount": 3
    }
  ],
  "line_items": [
    {
      "account_id": "00000000-0000-0000-0000-000000000000",
      "class_id": "00000000-0000-0000-0000-000000000000",
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "department_id": "00000000-0000-0000-0000-000000000000",
      "location_id": "00000000-0000-0000-0000-000000000000",
      "tax_rate_id": "00000000-0000-0000-0000-000000000000",
      "description": "A Rutter shirt.",
      "discount_amount": 0,
      "discount_percentage": 0,
      "sub_total": 12.34,
      "tax_amount": 2,
      "total_amount": 14.34,
      "item": {
        "id": "00000000-0000-0000-0000-000000000000",
        "quantity": 1,
        "unit_amount": 12.34
      }
    }
  ],
  "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 Bills

GET /accounting/bills

Supported for: Dynamics 365FreeAgentKashFlowNetSuiteQuickBooksQuickBooks DesktopSage IntacctXeroZoho 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

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

billsarray

Show bills attributes

next_cursorstringnullableoptional

Example Response Body

{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "bills": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "payment_terms_id": "00000000-0000-0000-0000-000000000000",
      "subsidiary_id": "00000000-0000-0000-0000-000000000000",
      "vendor_id": "00000000-0000-0000-0000-000000000000",
      "due_date": "2023-01-02T02:34:56.000Z",
      "issue_date": "2023-01-02T02:34:56.000Z",
      "amount_due": 9.34,
      "currency_code": "USD",
      "status": "partially_paid",
      "total_amount": 14.34,
      "document_number": "VENDBILL-1",
      "memo": "Bill description",
      "sub_total": 12.34,
      "tax_amount": 2,
      "total_discount": 0,
      "linked_purchase_orders": [
        {
          "id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "linked_credit_memos": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "allocated_date": "2023-01-02T02:34:56.000Z",
          "allocated_amount": 2
        }
      ],
      "linked_payments": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "allocated_date": "2023-01-02T02:34:56.000Z",
          "allocated_amount": 3
        }
      ],
      "line_items": [
        {
          "account_id": "00000000-0000-0000-0000-000000000000",
          "class_id": "00000000-0000-0000-0000-000000000000",
          "customer_id": "00000000-0000-0000-0000-000000000000",
          "department_id": "00000000-0000-0000-0000-000000000000",
          "location_id": "00000000-0000-0000-0000-000000000000",
          "tax_rate_id": "00000000-0000-0000-0000-000000000000",
          "description": "A Rutter shirt.",
          "discount_amount": 0,
          "discount_percentage": 0,
          "sub_total": 12.34,
          "tax_amount": 2,
          "total_amount": 14.34,
          "item": {
            "id": "00000000-0000-0000-0000-000000000000",
            "quantity": 1,
            "unit_amount": 12.34
          }
        }
      ],
      "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 Bill

GET /accounting/bills/:id

Supported for: Dynamics 365FreeAgentKashFlowNetSuiteQuickBooksQuickBooks DesktopSage IntacctXeroZoho 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

connectionobject

Show connection attributes

billobject

Show bill attributes

Example Response Body

{
  "connection": {
    "id": "00000000-0000-0000-0000-000000000000",
    "orgId": "00000000-0000-0000-0000-000000000000",
    "platform": "NETSUITE"
  },
  "bill": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "payment_terms_id": "00000000-0000-0000-0000-000000000000",
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
    "vendor_id": "00000000-0000-0000-0000-000000000000",
    "due_date": "2023-01-02T02:34:56.000Z",
    "issue_date": "2023-01-02T02:34:56.000Z",
    "amount_due": 9.34,
    "currency_code": "USD",
    "status": "partially_paid",
    "total_amount": 14.34,
    "document_number": "VENDBILL-1",
    "memo": "Bill description",
    "sub_total": 12.34,
    "tax_amount": 2,
    "total_discount": 0,
    "linked_purchase_orders": [
      {
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "linked_credit_memos": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_date": "2023-01-02T02:34:56.000Z",
        "allocated_amount": 2
      }
    ],
    "linked_payments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_date": "2023-01-02T02:34:56.000Z",
        "allocated_amount": 3
      }
    ],
    "line_items": [
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "class_id": "00000000-0000-0000-0000-000000000000",
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "department_id": "00000000-0000-0000-0000-000000000000",
        "location_id": "00000000-0000-0000-0000-000000000000",
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
        "description": "A Rutter shirt.",
        "discount_amount": 0,
        "discount_percentage": 0,
        "sub_total": 12.34,
        "tax_amount": 2,
        "total_amount": 14.34,
        "item": {
          "id": "00000000-0000-0000-0000-000000000000",
          "quantity": 1,
          "unit_amount": 12.34
        }
      }
    ],
    "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 Bill

POST /accounting/bills

Supported for: Dynamics 365FreeAgentNetSuiteQuickBooksQuickBooks DesktopSage IntacctXeroZoho Books

Request Parameters

access_tokenstringquery

The access token of the connection.

Request Body

billobject

Show bill attributes

Response Body

Any of:

billobject

Show bill attributes

async_responseobjectoptional

Show async_response attributes

errorsarrayoptional

Show errors attributes

Example Request Body

{
  "bill": {
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
    "vendor_id": "00000000-0000-0000-0000-000000000000",
    "due_date": "2023-01-02T02:34:56.000Z",
    "issue_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "line_items": [
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
        "total_amount": 12.34,
        "description": "A Rutter shirt.",
        "item": {
          "id": "00000000-0000-0000-0000-000000000000",
          "quantity": 1,
          "unit_amount": 12.34
        }
      }
    ]
  }
}

Example Response Body

{
  "bill": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "payment_terms_id": "00000000-0000-0000-0000-000000000000",
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
    "vendor_id": "00000000-0000-0000-0000-000000000000",
    "due_date": "2023-01-02T02:34:56.000Z",
    "issue_date": "2023-01-02T02:34:56.000Z",
    "amount_due": 9.34,
    "currency_code": "USD",
    "status": "partially_paid",
    "total_amount": 14.34,
    "document_number": "VENDBILL-1",
    "memo": "Bill description",
    "sub_total": 12.34,
    "tax_amount": 2,
    "total_discount": 0,
    "linked_purchase_orders": [
      {
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "linked_credit_memos": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_date": "2023-01-02T02:34:56.000Z",
        "allocated_amount": 2
      }
    ],
    "linked_payments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_date": "2023-01-02T02:34:56.000Z",
        "allocated_amount": 3
      }
    ],
    "line_items": [
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "class_id": "00000000-0000-0000-0000-000000000000",
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "department_id": "00000000-0000-0000-0000-000000000000",
        "location_id": "00000000-0000-0000-0000-000000000000",
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
        "description": "A Rutter shirt.",
        "discount_amount": 0,
        "discount_percentage": 0,
        "sub_total": 12.34,
        "tax_amount": 2,
        "total_amount": 14.34,
        "item": {
          "id": "00000000-0000-0000-0000-000000000000",
          "quantity": 1,
          "unit_amount": 12.34
        }
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}

Update a Bill

PATCH /accounting/bills/:id

Supported for: Dynamics 365QuickBooksSage IntacctXero

All fields are conditionally required. This means that if a field value is provided, that field will take the updated value. If the field is not provided, the existing value will persist.

Request Parameters

idstringpath

The Rutter generated unique ID of the object.

access_tokenstringquery

The access token of the connection.

Request Body

billobject

Show bill attributes

Response Body

Any of:

billobject

Show bill attributes

async_responseobjectoptional

Show async_response attributes

errorsarrayoptional

Show errors attributes

Example Request Body

{
  "bill": {
    "memo": "Example Memo"
  }
}

Example Response Body

{
  "bill": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "payment_terms_id": "00000000-0000-0000-0000-000000000000",
    "subsidiary_id": "00000000-0000-0000-0000-000000000000",
    "vendor_id": "00000000-0000-0000-0000-000000000000",
    "due_date": "2023-01-02T02:34:56.000Z",
    "issue_date": "2023-01-02T02:34:56.000Z",
    "amount_due": 9.34,
    "currency_code": "USD",
    "status": "partially_paid",
    "total_amount": 14.34,
    "document_number": "VENDBILL-1",
    "memo": "Bill description",
    "sub_total": 12.34,
    "tax_amount": 2,
    "total_discount": 0,
    "linked_purchase_orders": [
      {
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "linked_credit_memos": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_date": "2023-01-02T02:34:56.000Z",
        "allocated_amount": 2
      }
    ],
    "linked_payments": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_date": "2023-01-02T02:34:56.000Z",
        "allocated_amount": 3
      }
    ],
    "line_items": [
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "class_id": "00000000-0000-0000-0000-000000000000",
        "customer_id": "00000000-0000-0000-0000-000000000000",
        "department_id": "00000000-0000-0000-0000-000000000000",
        "location_id": "00000000-0000-0000-0000-000000000000",
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
        "description": "A Rutter shirt.",
        "discount_amount": 0,
        "discount_percentage": 0,
        "sub_total": 12.34,
        "tax_amount": 2,
        "total_amount": 14.34,
        "item": {
          "id": "00000000-0000-0000-0000-000000000000",
          "quantity": 1,
          "unit_amount": 12.34
        }
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z",
    "platform_data": {
      "id": 123,
      "data": "Varies by platform"
    }
  }
}