Credit Memos
Retrieve a credit memo
QuickBooks Desktop API
Core Resources
- Auth Sessions
- End Users
Utilities
Transactions
- All Transactions
- Bill Check Payments
- Bill Credit Card Payments
- Bills
- Checks
- Credit Card Charges
- Credit Card Credits
- Credit Memos
- Estimates
- Inventory Adjustments
- Invoices
- Item Receipts
- Journal Entries
- Purchase Orders
- Receive-Payments
- Sales Orders
- Sales Receipts
- Time Tracking Activities
- Transfers
- Vendor Credits
General
- Account Tax Lines
- Accounts
- Classes
- Company
- Customers / Jobs
- Date-Driven Terms
- Employees
- Inventory Sites
- Payment Methods
- Payroll Wage Items
- Preferences
- Price Levels
- Sales Representatives
- Sales-Tax Codes
- Standard Terms
- Vendors
Items
- Discount Items
- Inventory Assembly Items
- Inventory Items
- Item Groups
- Item Sites
- Non-Inventory Items
- Sales-Tax Items
- Service Items
- Subtotal Items
Credit Memos
Retrieve a credit memo
Retrieves a credit memo by ID.
GET
/
quickbooks-desktop
/
credit-memos
/
{id}
import Conductor from 'conductor-node';
const client = new Conductor({
apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});
async function main() {
const creditMemo = await client.qbd.creditMemos.retrieve('123ABC-1234567890', {
conductorEndUserId: 'end_usr_1234567abcdefg',
});
console.log(creditMemo.id);
}
main();
{
"id": "123ABC-1234567890",
"objectType": "qbd_credit_memo",
"createdAt": "2021-10-01T17:34:56.000Z",
"updatedAt": "2021-10-01T20:45:30.000Z",
"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": "2021-10-01",
"refNumber": "CM-1234",
"billingAddress": {
"line1": "Conductor Labs Inc.",
"line2": "540 Market St.",
"line3": "Suite 100",
"line4": "",
"line5": "",
"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",
"line4": "",
"line5": "",
"city": "San Francisco",
"state": "CA",
"postalCode": "94110",
"country": "United States",
"note": "Conductor HQ"
},
"isPending": false,
"purchaseOrderNumber": "PO-1234",
"terms": {
"id": "80000001-1234567890",
"fullName": "Net 30"
},
"dueDate": "2021-10-31",
"salesRepresentative": {
"id": "80000001-1234567890",
"fullName": "Jane Doe"
},
"shipmentOrigin": "San Francisco, CA",
"shippingDate": "2021-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": "2021-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",
"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"
}
]
}
Authorizations
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}"
).
Headers
The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}"
).
Example:
"end_usr_1234567abcdefg"
Path Parameters
The QuickBooks-assigned unique identifier of the credit memo to retrieve.
Example:
"123ABC-1234567890"
Response
200 - application/json
Returns the specified credit memo.
The response is of type object
.
import Conductor from 'conductor-node';
const client = new Conductor({
apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});
async function main() {
const creditMemo = await client.qbd.creditMemos.retrieve('123ABC-1234567890', {
conductorEndUserId: 'end_usr_1234567abcdefg',
});
console.log(creditMemo.id);
}
main();
{
"id": "123ABC-1234567890",
"objectType": "qbd_credit_memo",
"createdAt": "2021-10-01T17:34:56.000Z",
"updatedAt": "2021-10-01T20:45:30.000Z",
"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": "2021-10-01",
"refNumber": "CM-1234",
"billingAddress": {
"line1": "Conductor Labs Inc.",
"line2": "540 Market St.",
"line3": "Suite 100",
"line4": "",
"line5": "",
"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",
"line4": "",
"line5": "",
"city": "San Francisco",
"state": "CA",
"postalCode": "94110",
"country": "United States",
"note": "Conductor HQ"
},
"isPending": false,
"purchaseOrderNumber": "PO-1234",
"terms": {
"id": "80000001-1234567890",
"fullName": "Net 30"
},
"dueDate": "2021-10-31",
"salesRepresentative": {
"id": "80000001-1234567890",
"fullName": "Jane Doe"
},
"shipmentOrigin": "San Francisco, CA",
"shippingDate": "2021-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": "2021-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",
"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"
}
]
}