> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qubesync.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Query Credit Memos
> Executes a pre-built query to retrieve credit memo data from QuickBooks.
## OpenAPI
````yaml /api-reference/v1/openapi.json get /connections/{connection_id}/credit_memos
openapi: 3.0.0
info:
title: QuBe Sync API
description: Integrate with QuickBooks Desktop or QuickBooks Enterprise in a few steps.
version: 1.0.0
contact:
email: support@qubesync.com
servers:
- url: https://qubesync.com/api/v1
description: v1 API
- url: https://dev.qubesync.com/api/v1
description: Local development server
security: []
tags:
- name: Connections
description: Endpoints for managing QuickBooks connections
- name: Queued Requests
description: Endpoints for managing queued API requests
- name: Pre-built Queries
description: >-
Endpoints for executing pre-built queries against QuickBooks data. These
endpoints simplify common data retrieval operations by providing a
higher-level interface than the raw queued requests API. Each query is
executed asynchronously and returns a queued request ID that can be used
to check the status and retrieve results.
paths:
/connections/{connection_id}/credit_memos:
get:
tags:
- Pre-built Queries
summary: Query Credit Memos
description: Executes a pre-built query to retrieve credit memo data from QuickBooks.
operationId: queryCreditMemos
parameters:
- name: connection_id
in: path
required: true
schema:
type: string
format: uuid
description: ID of the connection to use for the query
- name: request_id
in: query
required: false
schema:
$ref: '#/components/schemas/request_id'
- name: iterate
in: query
required: false
schema:
$ref: '#/components/schemas/iterate'
- name: max_returned
in: query
required: false
schema:
type: integer
description: Maximum number of results to return
- name: include[]
in: query
required: false
schema:
type: array
items:
type: string
enum:
- 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
description: >-
List of fields for QuickBooks to include in the response. Values
correspond to the top-level elements of CreditMemoRet.
- name: customer_list_id
in: query
required: false
schema:
type: string
description: Filter credit memos by customer ListID
- name: from_transaction_date
in: query
required: false
schema:
type: string
format: date
description: >-
Filter credit memos with transaction dates on or after this date
(YYYY-MM-DD)
- name: to_transaction_date
in: query
required: false
schema:
type: string
format: date
description: >-
Filter credit memos with transaction dates on or before this date
(YYYY-MM-DD)
- name: from_modified_date
in: query
required: false
schema:
type: string
format: date
description: Filter credit memos modified after this date (ISO 8601 format)
- name: to_modified_date
in: query
required: false
schema:
type: string
format: date
description: Filter credit memos modified before this date (ISO 8601 format)
- name: account_list_id[]
in: query
required: false
schema:
items:
type: string
type: array
description: Filter credit memos by one or more account ListIDs
- name: ref_number
in: query
required: false
schema:
type: string
description: >-
Filter credit memos by reference number (partial match,
case-insensitive). Mutually exclusive with
from_ref_number/to_ref_number
- name: from_ref_number
in: query
required: false
schema:
type: string
description: >-
Filter credit memos with reference numbers starting from this value
(inclusive)
- name: to_ref_number
in: query
required: false
schema:
type: string
description: >-
Filter credit memos with reference numbers up to this value
(inclusive)
- name: currency_list_id[]
in: query
required: false
schema:
items:
type: string
type: array
description: Filter credit memos by one or more currency ListIDs
- name: include_line_items
in: query
required: false
schema:
type: boolean
default: false
description: Whether to include line item details in the response
- name: webhook_url
in: query
required: false
schema:
$ref: '#/components/schemas/webhook_url'
responses:
'202':
description: >-
Credit memos query accepted and queued for processing. Returns a
queued request object.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/QueuedRequest'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
security:
- apiKey: []
components:
schemas:
request_id:
type: string
description: >-
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:
type: boolean
description: >-
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
webhook_url:
type: string
format: uri
description: >-
Optional absolute http or https URL to receive a webhook when the
request is completed. It may not contain a username or password, and in
production it may not point at localhost or a private, loopback or
link-local address. A `qube listen` URL must be one of this app's.
maxLength: 2048
QueuedRequest:
type: object
properties:
id:
type: string
format: uuid
example: 550e8400-e29b-41d4-a716-446655440000
description: Unique identifier for the queued request
state:
type: string
enum:
- waiting
- retryable
- ticketed
- sent
- response_received
- error
- timed_out
- discarded
description: >-
Current state of the queued request. `timed_out`: no answer came
back (the customer's computer lost its connection, or QuickBooks or
the Web Connector was closed, mid-request), so QuickBooks may still
have applied it. `discarded`: it was discarded before the Web
Connector picked it up, so QuickBooks never got it.
page:
type: integer
example: 1
description: >-
The page number, for a multi-page (iterated) response; `1` for a
request that isn't iterated
original_request_id:
type: string
format: uuid
example: 550e8400-e29b-41d4-a716-446655440000
description: >-
The id of the first page of this request's iteration, the same on
every page of it: equal to `id` on the first page itself, and on a
request that isn't iterated
iteration_state:
type: string
enum:
- not_applicable
- continue
- done
- max_sandbox_iterations_reached
description: >-
Whether this response is part of an ongoing iteration, and if so,
whether more pages remain. Use this (not `state`) to tell whether a
multi-page response is complete.
request_types:
type: array
items:
type: string
example:
- CustomerQueryRq
description: The qbXML request type(s) in `request_xml`
webhook_state:
type: string
enum:
- not_applicable
- pending
- succeeded
- failed
description: >-
State of the webhook delivery. Not applicable if webhook_url was not
provided.
request_xml:
type: string
example: >-
100
description: The QBXML request to be processed
request_json:
type: object
nullable: true
description: The request payload in JSON format (alternative to request_xml)
example:
version: '13.0'
request:
name: CustomerQueryRq
attributes:
requestID: '1'
children:
- name: MaxReturned
text: '100'
response_xml:
type: string
nullable: true
example: >-
80000001-1234567890Sample
Customer
description: >-
The QBXML response from QuickBooks. One answer can be at most 4 MB
as the Web Connector sends it, about 3 MB of qbXML; QuickBooks'
answer over that isn't kept: this is null and `error.error_type` is
`response_too_large`. A webhook whose body would be over 1 MB is
sent without it: it is null there, `response_xml_omitted` is true,
and `links.self` is the URL to GET the request from, this field
included.
response_json:
type: array
items:
type: object
nullable: true
description: >-
The response payload in JSON format, if request is completed:
QuickBooks' qbXML answer as JSON, element for element. Each `*Rs`
element carries QuickBooks' `@statusCode`, `@statusSeverity` and
`@statusMessage`. `Info` is a success. `Warn` means QuickBooks
carried the request out but warned about something, and the `*Ret`
it answered with is still there: for example `@statusCode` 530, `The
field "Memo" is not supported by this implementation.`, means the
record was saved without that field. `Error` means QuickBooks
refused it.
webhook_url:
type: string
format: uri
nullable: true
example: https://example.com/webhook
description: >-
URL to receive a webhook when the request is completed. The webhook
carries the request as it then is, `response_xml` and
`response_json` included, so it is at most about twice the size
limit on one answer (see `response_xml`).
webhook_attempts:
type: array
items:
type: object
properties:
status:
type: string
enum:
- succeeded
- failed
description: >-
Whether the webhook endpoint accepted this delivery (a 2xx
answer)
sent_at:
type: string
format: date-time
description: When this delivery was attempted
error:
type: string
nullable: true
description: Why the delivery failed (`null` when it succeeded)
attempted_at:
type: string
format: date-time
description: 'Not sent: the time of an attempt is `sent_at`'
deprecated: true
response:
type: string
description: >-
Not sent: the outcome of an attempt is `status`, and a
failure's reason is `error`
deprecated: true
required:
- status
- sent_at
description: Every webhook delivery attempt for this request, newest first
webhook_error:
type: string
nullable: true
description: Error message if webhook delivery failed
error:
type: object
nullable: true
properties:
error_type:
type: string
enum:
- xml_error
- quickbooks_connection_error
- quickbooks_business_error
- unexpected_error
- response_too_large
- outcome_unknown
- timed_out
- discarded
description: >-
Where it failed. `timed_out`: no answer came back, and
QuickBooks may still have applied the request, so look before
sending it again. `discarded`: QuickBooks never got it.
`response_too_large`: QuickBooks answered, but with more than
QuBe Sync accepts for one answer (4 MB as the Web Connector
sends it, about 3 MB of qbXML), so `response_xml` and
`response_json` are null. QuickBooks ran the request: page the
query (`iterate`, or `iterator="Start"` with `` in
`request_xml`) or narrow it, and for a write, look before
sending it again. `outcome_unknown`: a write the Web Connector
answered with an error in place of QuickBooks' answer, so
whether QuickBooks applied it is not known: look in QuickBooks
before sending it again. A query that fails that way is
`unexpected_error`, and can be sent again.
message:
type: string
description: >-
The raw message from QuickBooks or the Web Connector; for
`timed_out` and `discarded`, which neither sent, QuBe Sync's own
user_message:
type: string
description: A friendly message for the end user
error_code:
type: integer
nullable: true
description: QuickBooks' statusCode, for a business error
hresult:
type: string
nullable: true
description: The Web Connector's HRESULT, for a connection or XML error
debug_message:
type: string
nullable: true
description: Which element of the request the value came from, when known
code:
type: string
description: 'Not sent: QuickBooks'' status code is `error_code`'
deprecated: true
details:
type: object
description: Not sent
deprecated: true
description: >-
Set when `state` is `error`, `retryable`, `timed_out` or
`discarded`. A `timed_out` request's `error_type` is `timed_out`,
and a `discarded` one's `discarded`, unless the request was
`retryable` when it was discarded: then it keeps the connection
error that held it up.
links:
type: object
properties:
self:
type: string
format: uri
example: >-
/api/v1/connections/123e4567-e89b-12d3-a456-426614174000/queued_requests/550e8400-e29b-41d4-a716-446655440000
ui:
type: string
format: uri
example: /app/queued_requests/550e8400-e29b-41d4-a716-446655440000
connection_ui:
type: string
format: uri
example: /app/connections/123e4567-e89b-12d3-a456-426614174000
pages:
type: string
format: uri
example: >-
/api/v2/connections/123e4567-e89b-12d3-a456-426614174000/queued-requests/550e8400-e29b-41d4-a716-446655440000/pages
description: >-
The pages of this request's iteration, oldest first. A v2 route
(`GET
/api/v2/connections/{connection_id}/queued-requests/{id}/pages`,
documented in the v2 API reference): v1 has none of its own, and
the same API key works there. It answers a page of them at a
time (`page`, `page_size`, at most 100) with a `meta` block, and
its rows are rendered as v1 renders this request.
required:
- self
- ui
- connection_ui
inserted_at:
type: string
format: date-time
example: '2023-01-01T12:00:00Z'
description: When the request was queued, UTC ISO 8601
updated_at:
type: string
format: date-time
example: '2023-01-01T12:00:01Z'
description: When the request was last updated
connection_id:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426614174000
description: ID of the connection this request belongs to
required:
- id
- connection_id
- state
- request_xml
Error:
description: >-
What a refused request answers with. The one key is errors, and its
shape says what went wrong: a sentence when the endpoint explains the
refusal in words (a parameter the operation does not take, a key already
taken, a run that has already ended); an object with detail, and a code
when there is one, when the request named nothing that exists or may not
do what it asked (402, 403, 404, and a CLI session's 401), or an answer
to a run's question was refused (the decisions endpoint's 400, 409 and
422, which always carry a code to branch on); an object of fields, each
a list of messages, when a record failed validation and nothing was
saved; a list of {path, message} problems when a submitted document or
input fails validation. A request without a usable API key gets a 401
Basic challenge with the plain-text body Unauthorized, not JSON.
properties:
errors:
oneOf:
- example: 'unknown parameter: "emial"'
title: A sentence
type: string
- properties:
code:
example: read_only_session
type: string
detail:
example: Not Found
type: string
required:
- detail
title: Detail and code
type: object
- additionalProperties:
items:
type: string
type: array
example:
redirect_url:
- must be a valid URL
title: Field by field
type: object
- items:
properties:
message:
example: is required
type: string
path:
example: input.customer
type: string
required:
- path
- message
type: object
title: Located problems
type: array
required:
- errors
type: object
responses:
BadRequest:
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
errors: 'unknown parameter: "emial"'
Unauthorized:
description: >-
No usable API key. The key is Basic auth, so the answer is the
challenge, with the plain-text body Unauthorized rather than JSON.
headers:
WWW-Authenticate:
schema:
type: string
example: Basic realm="Application"
content:
text/plain:
schema:
type: string
example: Unauthorized
NotFound:
description: The requested resource was not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
errors:
detail: Not Found
UnprocessableEntity:
description: >-
A field failed validation, field by field, and nothing was queued: such
as a `webhook_url` that is not an absolute http or https URL, carries a
username or password, or (in production) points at localhost or a
private address.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
errors:
webhook_url:
- must be an http or https URL
securitySchemes:
apiKey:
type: http
scheme: basic
description: Use your app's API_KEY as the username, and leave the password blank
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.