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

The InvoiceCreditMemo object

A Rutter Invoice Credit Memo represents an invoice credit memo issued to a customer that can be applied against an invoice. Every invoice credit memo is linked to an Customer and zero or more Invoices.

Properties

idstring

The Rutter generated unique ID of the invoice credit memo.

platform_idstring

The platform specific ID of the invoice credit memo.

account_idstringnullable

The Rutter ID of the Account linked to the invoice. Represents the account being debited.

customer_idstringnullable

The Rutter ID of the Customer linked to the invoice credit memo.

allocated_atstringnullable

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

issue_datestringnullable

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

currency_codestringnullable

The ISO 4217 currency code of the invoice credit memo.

document_numberstringnullable

The buyer facing document number of the invoice credit memo.

memostringnullable

The memo of the invoice credit memo.

statusenumnullable

The status of the invoice credit memo.

One ofOPEN, APPLIED, PARTIALLY_APPLIED, DRAFT, or UNKNOWN.

remaining_amountstringnullable

The remaining unapplied amount of the invoice credit memo.

total_amountstringnullable

The total amount on the invoice credit memo.

linked_invoicesarray

An array of Rutter IDs of Invoices linked to the invoice credit memo.

Show linked_invoices attributes

line_itemsarray

An array of line items containing details about the invoice credit memo.

Show line_items attributes

created_atstringnullable

The ISO 8601 timestamp that the invoice credit memo was created.

updated_atstringnullable

The ISO 8601 timestamp that the invoice credit memo was last updated.

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes

Example InvoiceCreditMemo Object

{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "account_id": "00000000-0000-0000-0000-000000000000",
  "customer_id": "00000000-0000-0000-0000-000000000000",
  "allocated_at": "2023-01-02T02:34:56.000Z",
  "issue_date": "2023-01-02T02:34:56.000Z",
  "currency_code": "USD",
  "document_number": "CUSTCRED-1",
  "memo": "Discount for future Rutter shirts.",
  "status": "APPLIED",
  "remaining_amount": "0",
  "total_amount": "3",
  "linked_invoices": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "allocated_amount": "3"
    }
  ],
  "line_items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "item_id": "00000000-0000-0000-0000-000000000000",
      "tax_rate_id": "00000000-0000-0000-0000-000000000000",
      "description": "A Rutter shirt.",
      "quantity": 1,
      "amount": "14.34",
      "discount_amount": "0",
      "discount_percentage": "0",
      "sub_total": "12.34",
      "tax_amount": "2",
      "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 Invoice Credit Memos

GET /accounting/invoice_credit_memos

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

invoice_credit_memosarray

Show invoice_credit_memos attributes

next_cursorstringnullableoptional

Example Response Body

{
  "invoice_credit_memos": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "customer_id": "00000000-0000-0000-0000-000000000000",
      "allocated_at": "2023-01-02T02:34:56.000Z",
      "issue_date": "2023-01-02T02:34:56.000Z",
      "currency_code": "USD",
      "document_number": "CUSTCRED-1",
      "memo": "Discount for future Rutter shirts.",
      "status": "APPLIED",
      "remaining_amount": "0",
      "total_amount": "3",
      "linked_invoices": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "allocated_amount": "3"
        }
      ],
      "line_items": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "platform_id": "12345678",
          "account_id": "00000000-0000-0000-0000-000000000000",
          "item_id": "00000000-0000-0000-0000-000000000000",
          "tax_rate_id": "00000000-0000-0000-0000-000000000000",
          "description": "A Rutter shirt.",
          "quantity": 1,
          "amount": "14.34",
          "discount_amount": "0",
          "discount_percentage": "0",
          "sub_total": "12.34",
          "tax_amount": "2",
          "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 an Invoice Credit Memo

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

invoice_credit_memoobject

Show invoice_credit_memo attributes

Example Response Body

{
  "invoice_credit_memo": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "allocated_at": "2023-01-02T02:34:56.000Z",
    "issue_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "document_number": "CUSTCRED-1",
    "memo": "Discount for future Rutter shirts.",
    "status": "APPLIED",
    "remaining_amount": "0",
    "total_amount": "3",
    "linked_invoices": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_amount": "3"
      }
    ],
    "line_items": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "platform_id": "12345678",
        "account_id": "00000000-0000-0000-0000-000000000000",
        "item_id": "00000000-0000-0000-0000-000000000000",
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
        "description": "A Rutter shirt.",
        "quantity": 1,
        "amount": "14.34",
        "discount_amount": "0",
        "discount_percentage": "0",
        "sub_total": "12.34",
        "tax_amount": "2",
        "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 an Invoice Credit Memo

POST /accounting/invoice_credit_memos

Supported for: NetSuiteQuickBooksSage IntacctXero

Request Parameters

access_tokenstringquery

The access token of the connection.

Request Body

invoice_credit_memoobject

Show invoice_credit_memo attributes

Response Body

Any of:

invoice_credit_memoobject

Show invoice_credit_memo attributes

async_responseobjectoptional

Show async_response attributes

errorsarrayoptional

Show errors attributes

Example Request Body

{
  "invoice_credit_memo": {
    "account_id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "issue_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "line_items": [
      {
        "account_id": "00000000-0000-0000-0000-000000000000",
        "description": "Discount for future Rutter shirts.",
        "total_amount": "3",
        "item": {
          "id": "00000000-0000-0000-0000-000000000000",
          "quantity": 1,
          "unit_amount": "3"
        }
      }
    ]
  }
}

Example Response Body

{
  "invoice_credit_memo": {
    "id": "00000000-0000-0000-0000-000000000000",
    "platform_id": "12345678",
    "account_id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "allocated_at": "2023-01-02T02:34:56.000Z",
    "issue_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "document_number": "CUSTCRED-1",
    "memo": "Discount for future Rutter shirts.",
    "status": "APPLIED",
    "remaining_amount": "0",
    "total_amount": "3",
    "linked_invoices": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_amount": "3"
      }
    ],
    "line_items": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "platform_id": "12345678",
        "account_id": "00000000-0000-0000-0000-000000000000",
        "item_id": "00000000-0000-0000-0000-000000000000",
        "tax_rate_id": "00000000-0000-0000-0000-000000000000",
        "description": "A Rutter shirt.",
        "quantity": 1,
        "amount": "14.34",
        "discount_amount": "0",
        "discount_percentage": "0",
        "sub_total": "12.34",
        "tax_amount": "2",
        "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 an Invoice Credit Memo Application

POST /accounting/invoice_credit_applications

Supported for: NetSuiteQuickBooksSage IntacctXero

Request Parameters

access_tokenstringquery

The access token of the connection.

Request Body

invoice_credit_applicationobject

Show invoice_credit_application attributes

Response Body

Any of:

invoice_credit_applicationobject

Show invoice_credit_application attributes

async_responseobjectoptional

Show async_response attributes

errorsarrayoptional

Show errors attributes

Example Request Body

{
  "invoice_credit_application": {
    "account_id": "00000000-0000-0000-0000-000000000000",
    "customer_id": "00000000-0000-0000-0000-000000000000",
    "invoice_credit_memo_id": "00000000-0000-0000-0000-000000000000",
    "transaction_date": "2023-01-02T02:34:56.000Z",
    "currency_code": "USD",
    "memo": "Applying vendor credit for the invoice.",
    "linked_invoices": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "allocated_amount": 12.34
      }
    ]
  }
}

Example Response Body

{
  "invoice_credit_application": {
    "success": true
  }
}