Skip to main content
GET
Query Credit Memos

Authorizations

Authorization
string
header
required

Use your app's API_KEY as the username, and leave the password blank

Path Parameters

connection_id
string<uuid>
required

ID of the connection to use for the query

Query Parameters

request_id
string

A custom ID that can be used to identify the request and response. This could be your local ID for the request.

Example:

"1"

iterate
boolean

If true, QuBe Sync will automatically handle the QBXML iteration until all records are returned. Each page of results will have its own request record and webhook. The id and webhook_url will be the same across each page request, and there will also be page_request_id, page values to distinguish pages from each other.

Example:

true

max_returned
integer

Maximum number of results to return

include[]
enum<string>[]

List of fields for QuickBooks to include in the response. Values correspond to the top-level elements of CreditMemoRet.

Available options:
TxnID,
TimeCreated,
TimeModified,
EditSequence,
TxnNumber,
CustomerRef,
ClassRef,
ARAccountRef,
TemplateRef,
TxnDate,
RefNumber,
BillAddress,
BillAddressBlock,
ShipAddress,
ShipAddressBlock,
IsPending,
PONumber,
TermsRef,
DueDate,
SalesRepRef,
FOB,
ShipDate,
ShipMethodRef,
Subtotal,
ItemSalesTaxRef,
SalesTaxPercentage,
SalesTaxTotal,
TotalAmount,
CreditRemaining,
CurrencyRef,
ExchangeRate,
CreditRemainingInHomeCurrency,
Memo,
CustomerMsgRef,
IsToBePrinted,
IsToBeEmailed,
IsTaxIncluded,
CustomerSalesTaxCodeRef,
Other,
ExternalGUID,
LinkedTxn,
CreditMemoLineRet,
CreditMemoLineGroupRet,
DiscountLineRet,
SalesTaxLineRet,
ShippingLineRet,
DataExtRet
customer_list_id
string

Filter credit memos by customer ListID

from_transaction_date
string<date>

Filter credit memos with transaction dates on or after this date (YYYY-MM-DD)

to_transaction_date
string<date>

Filter credit memos with transaction dates on or before this date (YYYY-MM-DD)

from_modified_date
string<date>

Filter credit memos modified after this date (ISO 8601 format)

to_modified_date
string<date>

Filter credit memos modified before this date (ISO 8601 format)

account_list_id[]
string[]

Filter credit memos by one or more account ListIDs

ref_number
string

Filter credit memos by reference number (partial match, case-insensitive). Mutually exclusive with from_ref_number/to_ref_number

from_ref_number
string

Filter credit memos with reference numbers starting from this value (inclusive)

to_ref_number
string

Filter credit memos with reference numbers up to this value (inclusive)

currency_list_id[]
string[]

Filter credit memos by one or more currency ListIDs

include_line_items
boolean
default:false

Whether to include line item details in the response

webhook_url
string<uri>

Optional URL to receive a webhook when the request is completed

Response

Credit memos query accepted and queued for processing. Returns a queued request object.

data
object