COconductor-is

Retrieve a credit memo

Changed on

Retrieves a credit memo by ID.

IMPORTANT: If you need to fetch multiple specific credit memos by ID, use the list endpoint instead with the ids parameter. It accepts an array of IDs so you can batch the request into a single call, which is significantly faster.

NOTE: The response automatically includes any linked transactions.

get/quickbooks-desktop/credit-memos/{id}

Request

Path parameters

idstring required

The QuickBooks-assigned unique identifier of the credit memo to retrieve.

Example:123ABC-1234567890

Headers

Conductor-End-User-Idstring required

The ID of the End-User to receive this request.

Example:end_usr_1234567abcdefg

Response

Returns the specified credit memo.

idstring required

The unique identifier assigned by QuickBooks to this credit memo. This ID is unique across all transaction types.

objectType'qbd_credit_memo' required

The type of object. This value is always "qbd_credit_memo".

createdAtstring required

The date and time when this credit memo was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

updatedAtstring required

The date and time when this credit memo was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop interprets in the local timezone of the end-user's computer.

revisionNumberstring required

The current QuickBooks-assigned revision number of this credit memo object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

transactionDatestring date required

The date of this credit memo, in ISO 8601 format (YYYY-MM-DD).

refNumberstring nullable required

The case-sensitive user-defined reference number for this credit memo, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.

isPendingboolean nullable required

Indicates whether this credit memo has not been completed.

purchaseOrderNumberstring nullable required

The customer's Purchase Order (PO) number associated with this credit memo. This field is often used to cross-reference the credit memo with the customer's purchasing system.

dueDatestring date nullable required

The date by which this credit memo must be paid, in ISO 8601 format (YYYY-MM-DD).

shipmentOriginstring nullable required

The origin location from where the product associated with this credit memo is shipped. This is the point at which ownership and liability for goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB" for this field, which stands for "freight on board". This field is informational and has no accounting implications.

shippingDatestring date nullable required

The date when the products or services for this credit memo were shipped or are expected to be shipped, in ISO 8601 format (YYYY-MM-DD).

subtotalstring required

The subtotal of this credit memo, which is the sum of all credit memo lines before taxes and payments are applied, represented as a decimal string.

salesTaxPercentagestring nullable required

The sales tax percentage applied to this credit memo, represented as a decimal string.

salesTaxTotalstring nullable required

The total amount of sales tax charged for this credit memo, represented as a decimal string.

totalAmountstring required

The total monetary amount of this credit memo, equivalent to the sum of the amounts in lines and lineGroups, represented as a decimal string.

creditRemainingstring nullable required

The remaining balance of this credit memo that has not yet been applied to other transactions or refunded to the customer. Represented as a decimal string.

exchangeRatenumber nullable required

The market exchange rate between this credit memo's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).

creditRemainingInHomeCurrencystring nullable required

The remaining balance of this credit memo converted to the home currency of the QuickBooks company file. Represented as a decimal string.

memostring nullable required

A memo or note for this credit memo that appears in the account register and customer register, but not on the credit memo itself.

isQueuedForPrintboolean nullable required

Indicates whether this credit memo is included in the queue of documents for QuickBooks to print.

isQueuedForEmailboolean nullable required

Indicates whether this credit memo is included in the queue of documents for QuickBooks to email to the customer.

otherCustomFieldstring nullable required

A built-in custom field for additional information specific to this credit memo. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all credit memos for convenience. Developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Unlike otherCustomField1 and otherCustomField2, which are line item fields, this exists at the transaction level. Hidden by default in the QuickBooks UI.

externalIdstring nullable required

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system. This field is immutable and can only be set during object creation.

Example response

{
  "id": "123ABC-1234567890",
  "objectType": "qbd_credit_memo",
  "createdAt": "2025-01-01T12:34:56+00:00",
  "updatedAt": "2025-02-01T12:34:56+00:00",
  "revisionNumber": "1721172183",
  "customer": {
    "id": "80000001-1234567890",
    "fullName": "Acme Corporation"
  },
  "class": {
    "id": "80000001-1234567890",
    "fullName": "Refunds"
  },
  "receivablesAccount": {
    "id": "80000001-1234567890",
    "fullName": "Accounts-Receivable"
  },
  "documentTemplate": {
    "id": "80000001-1234567890",
    "fullName": "Credit Memo Template"
  },
  "transactionDate": "2024-10-01",
  "refNumber": "CM-1234",
  "billingAddress": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "shippingAddress": {
    "line1": "Conductor Labs Inc.",
    "line2": "540 Market St.",
    "line3": "Suite 100",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94110",
    "country": "United States",
    "note": "Conductor HQ"
  },
  "purchaseOrderNumber": "PO-1234",
  "terms": {
    "id": "80000001-1234567890",
    "fullName": "Net 30"
  },
  "dueDate": "2024-10-31",
  "salesRepresentative": {
    "id": "80000001-1234567890",
    "fullName": "Jane Doe"
  },
  "shipmentOrigin": "San Francisco, CA",
  "shippingDate": "2024-10-01",
  "shippingMethod": {
    "id": "80000001-1234567890",
    "fullName": "FedEx Ground"
  },
  "subtotal": "1000.00",
  "salesTaxItem": {
    "id": "80000001-1234567890",
    "fullName": "State Sales Tax"
  },
  "salesTaxPercentage": "0.07",
  "salesTaxTotal": "10.00",
  "totalAmount": "1000.00",
  "creditRemaining": "25.11",
  "currency": {
    "id": "80000001-1234567890",
    "fullName": "USD"
  },
  "exchangeRate": 1.2345,
  "creditRemainingInHomeCurrency": "25.11",
  "memo": "Customer refund for damaged shipment",
  "customerMessage": {
    "id": "80000001-1234567890",
    "fullName": "Thank you for your business!"
  },
  "isQueuedForPrint": true,
  "isQueuedForEmail": true,
  "salesTaxCode": {
    "id": "80000001-1234567890",
    "fullName": "Non"
  },
  "otherCustomField": "Special handling required",
  "externalId": "12345678-abcd-1234-abcd-1234567890ab",
  "linkedTransactions": [
    {
      "id": "123ABC-1234567890",
      "objectType": "qbd_linked_transaction",
      "transactionType": "invoice",
      "transactionDate": "2024-10-01",
      "refNumber": "LINK-1234",
      "linkType": "amount",
      "amount": "1000.00"
    }
  ],
  "lines": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_credit_memo_line",
      "item": {
        "id": "80000001-1234567890",
        "fullName": "Widget A"
      },
      "description": "Return of defective product - Widget Model X123",
      "quantity": 5,
      "unitOfMeasure": "Each",
      "overrideUnitOfMeasureSet": {
        "id": "80000001-1234567890",
        "fullName": "Volume Units"
      },
      "rate": "10.00",
      "ratePercent": "10.5",
      "class": {
        "id": "80000001-1234567890",
        "fullName": "Refunds"
      },
      "amount": "1000.00",
      "inventorySite": {
        "id": "80000001-1234567890",
        "fullName": "Main Warehouse"
      },
      "inventorySiteLocation": {
        "id": "80000001-1234567890",
        "fullName": "Aisle 3, Shelf B"
      },
      "serialNumber": "SN1234567890",
      "lotNumber": "LOT2023-001",
      "expirationDate": "2025-12-31",
      "serviceDate": "2024-03-15",
      "salesTaxCode": {
        "id": "80000001-1234567890",
        "fullName": "Non"
      },
      "otherCustomField1": "Special handling required",
      "otherCustomField2": "Always ship with a spare",
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "lineGroups": [
    {
      "id": "456DEF-1234567890",
      "objectType": "qbd_credit_memo_line_group",
      "itemGroup": {
        "id": "80000001-1234567890",
        "fullName": "Office Supplies Bundle"
      },
      "description": "Service Bundle 1",
      "quantity": 5,
      "unitOfMeasure": "Each",
      "overrideUnitOfMeasureSet": {
        "id": "80000001-1234567890",
        "fullName": "Volume Units"
      },
      "shouldPrintItemsInGroup": true,
      "totalAmount": "1000.00",
      "serviceDate": "2024-03-15",
      "lines": [
        {
          "id": "456DEF-1234567890",
          "objectType": "qbd_credit_memo_line",
          "item": {
            "id": "80000001-1234567890",
            "fullName": "Widget A"
          },
          "description": "Return of defective product - Widget Model X123",
          "quantity": 5,
          "unitOfMeasure": "Each",
          "overrideUnitOfMeasureSet": {
            "id": "80000001-1234567890",
            "fullName": "Volume Units"
          },
          "rate": "10.00",
          "ratePercent": "10.5",
          "class": {
            "id": "80000001-1234567890",
            "fullName": "Refunds"
          },
          "amount": "1000.00",
          "inventorySite": {
            "id": "80000001-1234567890",
            "fullName": "Main Warehouse"
          },
          "inventorySiteLocation": {
            "id": "80000001-1234567890",
            "fullName": "Aisle 3, Shelf B"
          },
          "serialNumber": "SN1234567890",
          "lotNumber": "LOT2023-001",
          "expirationDate": "2025-12-31",
          "serviceDate": "2024-03-15",
          "salesTaxCode": {
            "id": "80000001-1234567890",
            "fullName": "Non"
          },
          "otherCustomField1": "Special handling required",
          "otherCustomField2": "Always ship with a spare",
          "customFields": [
            {
              "ownerId": "0",
              "name": "Customer Rating",
              "type": "string_1024_type",
              "value": "Premium"
            }
          ]
        }
      ],
      "customFields": [
        {
          "ownerId": "0",
          "name": "Customer Rating",
          "type": "string_1024_type",
          "value": "Premium"
        }
      ]
    }
  ],
  "customFields": [
    {
      "ownerId": "0",
      "name": "Customer Rating",
      "type": "string_1024_type",
      "value": "Premium"
    }
  ]
}

Changes

  • 8ee3502091a4Revision changes
    • warning

      added the new transfer_inventory enum value to the // response property for the response status

  • 1de07095c4b7Revision changes
    • warning

      for the path request parameter id, the maxLength was set to 36