Create a credit memo
Creates a new credit memo.
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}}").
Body
The customer or customer-job associated with this credit memo.
The date of this credit memo, in ISO 8601 format (YYYY-MM-DD).
The credit memo's billing address.
The credit memo's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default. A class defined here is automatically used in this credit memo's line items unless overridden at the line item level.
The message to display to the customer on the credit memo.
The predefined template in QuickBooks that determines the layout and formatting for this credit memo when printed or displayed.
The date by which this credit memo must be paid, in ISO 8601 format (YYYY-MM-DD).
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).
A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system.
IMPORTANT: Must be formatted as a valid GUID; otherwise, QuickBooks will return an error. This field is immutable and can only be set during object creation.
Indicates whether this credit memo has not been completed.
Indicates whether this credit memo is included in the queue of documents for QuickBooks to email to the customer.
Indicates whether this credit memo is included in the queue of documents for QuickBooks to print.
The credit memo's line item groups, each representing a predefined set of related items.
IMPORTANT: You must specify lines, lineGroups, or both when creating a credit memo.
The credit memo's line items, each representing a single product or service sold.
IMPORTANT: You must specify lines, lineGroups, or both when creating a credit memo.
A memo or note for this credit memo that appears in the account register and customer register, but not on the credit memo itself.
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.
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.
The Accounts-Receivable (A/R) account to which this credit memo is assigned, used to track the amount owed. If not specified, QuickBooks Desktop will use its default A/R account.
IMPORTANT: If this credit memo is linked to other transactions, this A/R account must match the receivablesAccount used in all linked transactions. For example, when refunding a credit card payment, the A/R account must match the one used in the original credit transactions being refunded.
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.
The credit memo's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.
The sales-tax code for this credit memo, determining whether it is taxable or non-taxable. This can be overridden at the transaction-line level.
Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.
The sales-tax item used to calculate the actual tax amount for this credit memo's transactions by applying a specific tax rate collected for a single tax agency. Unlike salesTaxCode, which only indicates general taxability, this field drives the actual tax calculation and reporting.
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.
The credit memo's shipping address.
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).
The shipping method used for this credit memo, such as standard mail or overnight delivery.
The credit memo's payment terms, defining when payment is due and any applicable discounts.
Response
The credit memo's billing address.
The credit memo's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default. A class defined here is automatically used in this credit memo's line items unless overridden at the line item level.
The date and time when this credit memo was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.
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.
The remaining balance of this credit memo converted to the home currency of the QuickBooks company file. Represented as a decimal string.
The credit memo's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.
The customer or customer-job associated with this credit memo.
The message to display to the customer on the credit memo.
The custom fields for the credit memo object, added as user-defined data extensions, not included in the standard QuickBooks object.
The predefined template in QuickBooks that determines the layout and formatting for this credit memo when printed or displayed.
The date by which this credit memo must be paid, in ISO 8601 format (YYYY-MM-DD).
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).
A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system.
The unique identifier assigned by QuickBooks to this credit memo. This ID is unique across all transaction types.
Indicates whether this credit memo has not been completed.
Indicates whether this credit memo is included in the queue of documents for QuickBooks to email to the customer.
Indicates whether this credit memo is included in the queue of documents for QuickBooks to print.
The credit memo's line item groups, each representing a predefined set of related items.
The credit memo's line items, each representing a single product or service sold.
The credit memo's linked transactions, such as payments applied, credits used, or associated purchase orders.
IMPORTANT: You must specify the parameter includeLinkedTransactions when fetching a list of credit memos to receive this field because it is not returned by default.
A memo or note for this credit memo that appears in the account register and customer register, but not on the credit memo itself.
The type of object. This value is always "qbd_credit_memo".
"qbd_credit_memo"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.
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.
The Accounts-Receivable (A/R) account to which this credit memo is assigned, used to track the amount owed. If not specified, QuickBooks Desktop will use its default A/R account.
IMPORTANT: If this credit memo is linked to other transactions, this A/R account must match the receivablesAccount used in all linked transactions. For example, when refunding a credit card payment, the A/R account must match the one used in the original credit transactions being refunded.
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.
The current 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.
The credit memo's sales representative. Sales representatives can be employees, vendors, or other names in QuickBooks.
The sales-tax code for this credit memo, determining whether it is taxable or non-taxable. This can be overridden at the transaction-line level.
Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.
The sales-tax item used to calculate the actual tax amount for this credit memo's transactions by applying a specific tax rate collected for a single tax agency. Unlike salesTaxCode, which only indicates general taxability, this field drives the actual tax calculation and reporting.
The sales tax percentage applied to this credit memo, represented as a decimal string.
The total amount of sales tax charged for this credit memo, represented as a decimal string.
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.
The credit memo's shipping address.
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).
The shipping method used for this credit memo, such as standard mail or overnight delivery.
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.
The credit memo's payment terms, defining when payment is due and any applicable discounts.
The total monetary amount of this credit memo, equivalent to the sum of the amounts in lines and lineGroups, represented as a decimal string.
The date of this credit memo, in ISO 8601 format (YYYY-MM-DD).
The date and time when this credit memo was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.