Bill Credit Memos - Rutter API Reference - the Common Language for Business Data

The BillCreditMemo object

A Rutter Bill Credit Memo represents a bill credit memo issued from a vendor that can be applied against a bill. Every bill credit memo is linked to an Vendor and zero or more Bills.

Properties

idstring

The Rutter generated unique ID of the bill credit memo.

platform_idstring

The platform specific ID of the bill credit memo.

memostringnullable

The memo of the bill credit memo

document_numberstring

The buyer facing document number of the bill credit memo.

account_idstringnullable

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

vendor_idstringnullable

The Rutter ID of the Vendor linked to the bill credit memo.

issue_datestring

The ISO 8601 timestamp for when the bill credit memo was issued.

currency_codeenumnullable

The ISO 4217 currency code of the bill credit memo.

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.

statusenum

The status of the bill credit memo.

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

created_atstringnullable

updated_atstringnullable

platform_dataoptional

The raw platform data corresponding to the Rutter object.

line_itemsarray

An array of line items associated with the BillCreditMemo.

Show line_items attributes

linked_billsarray

An array of Rutter IDs of BillCreditMemo Payments applied against the BillCreditMemo.

Show linked_bills attributes

allocated_atstringnullable

The ISO 8601 timestamp for when the bill credit memo was allocated.

total_amountstringnullable

The total amount of the bill credit memo.

remaining_amountstringnullable

The remaining unapplied amount of the bill credit memo.

Example BillCreditMemo Object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "vendor_id": "00000000-0000-0000-0000-000000000000",
  "account_id": "00000000-0000-0000-0000-000000000000",
  "document_number": "VENDCRED-1",
  "issue_date": "2023-01-02T02:34:56.000Z",
  "allocated_at": "2023-01-02T02:34:56.000Z",
  "currency_code": "USD",
  "memo": "Discount for future Rutter shirts.",
  "status": "paid",
  "total_amount": "3",
  "remaining_amount": "0",
  "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"
    }
  ],
  "linked_bills": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "allocated_amount": "3",
      "allocated_date": "2023-01-02T02:34:56.000Z"
    }
  ],
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z"
}

List Bill Credit Memos

GET /accounting/bill_credit_memos

Supported for: NetSuiteQuickBooksQuickBooks DesktopXero

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

bill_credit_memosarray

Show bill_credit_memos attributes

next_cursorstringnullableoptional

Example Response Body

{
  "bill_credit_memos": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "vendor_id": "00000000-0000-0000-0000-000000000000",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "document_number": "VENDCRED-1",
      "issue_date": "2023-01-02T02:34:56.000Z",
      "allocated_at": "2023-01-02T02:34:56.000Z",
      "currency_code": "USD",
      "memo": "Discount for future Rutter shirts.",
      "status": "paid",
      "total_amount": "3",
      "remaining_amount": "0",
      "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"
        }
      ],
      "linked_bills": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "allocated_amount": "3",
          "allocated_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 Credit Memo

GET /accounting/bill_credit_memos/:id

Supported for: NetSuiteQuickBooksQuickBooks DesktopXero

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

bill_credit_memoBillCreditMemo

Show bill_credit_memo attributes

Example Response Body

{
  "bill_credit_memo": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "vendor_id": "00000000-0000-0000-0000-000000000000",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "document_number": "VENDCRED-1",
    "issue_date": "2023-01-02T02:34:56.000Z",
    "allocated_at": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "memo": "Discount for future Rutter shirts.",
    "status": "paid",
    "total_amount": "3",
    "remaining_amount": "0",
    "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"
      }
    ],
    "linked_bills": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_amount": "3",
        "allocated_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 Credit Memo

POST /accounting/bill_credit_memos

Supported for: NetSuiteQuickBooksQuickBooks DesktopXero

Request Parameters

access_tokenstringquery

The access token of the connection.

Request Body

bill_credit_memoBill Credit Memo

Show bill_credit_memo attributes

Response Body

Any of:

BillCreditMemo Response

bill_credit_memoBillCreditMemo

Show bill_credit_memo attributes

Async Response Payload

async_responseobjectoptional

Show async_response attributes

errorsarrayoptional

Show errors attributes

Example Response Body

{
  "bill_credit_memo": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "vendor_id": "00000000-0000-0000-0000-000000000000",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "document_number": "VENDCRED-1",
    "issue_date": "2023-01-02T02:34:56.000Z",
    "allocated_at": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "memo": "Discount for future Rutter shirts.",
    "status": "paid",
    "total_amount": "3",
    "remaining_amount": "0",
    "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"
      }
    ],
    "linked_bills": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_amount": "3",
        "allocated_date": "2023-01-02T02:34:56.000Z"
      }
    ],
    "created_at": "2023-01-02T02:34:56.000Z",
    "updated_at": "2023-01-02T02:34:56.000Z"
  }
}

Create a Bill Credit Application

POST /accounting/bill_credit_applications

Supported for: NetSuiteQuickBooks

Request Parameters

access_tokenstringquery

The access token of the connection.

Request Body

bill_credit_applicationobject

Show bill_credit_application attributes

Response Body

Any of:

Create Bill Credit Application Response Response

bill_credit_applicationCreate Bill Credit Application Response

Show bill_credit_application attributes

Async Response Payload

async_responseobjectoptional

Show async_response attributes

errorsarrayoptional

Show errors attributes

Example Request Body

{
  "bill_credit_application": {
    "bill_credit_memo_id": "00000000-0000-0000-0000-000000000000",
    "vendor_id": "00000000-0000-0000-0000-000000000000",
    "currency_code": "USD",
    "transaction_date": "2023-01-02T02:34:56.000Z",
    "memo": "Applying vendor credit for bill.",
    "linked_bills": [
      {
        "allocated_amount": 12.34,
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ]
  }
}

Example Response Body

{
  "bill_credit_application": {
    "success": true
  }
}