List all creditmemoes

Updated:

GET/accounting/{connection_id}/creditmemo

Returns a list of AccountingCreditmemoes. Narrow the results with the query parameters before paging, then page through them with `limit` and `offset` (the default and maximum page size depend on the integration). Use `fields` to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the `X-Total-Count` response header. Use each item's `id` to retrieve, update, or delete it where those operations are supported.

Parameters

limitnumber default=100
offsetnumber default=0
updated_gtedate-time
Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sort enum
order enum
querystring
Query string to search. eg. email address or name
contact_idstring
The contact ID to filter by (reference to AccountingContact)
org_idstring
The org ID to filter by (reference to AccountingOrganization)
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Returns

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
due_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
paid_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
refunded_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
cancelled_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
posted_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
total_amountnumber
paid_amountnumber
refund_amountnumber
tax_amountnumber
discount_amountnumber
balance_amountnumber
creditmemo_numberstring
External identifier for this invoice
contact_idstring
(reference to AccountingContact)
invoice_idstring
(reference to AccountingInvoice)
currencystring
notesstring
refund_reasonstring
lineitems array
status enum
Valid values:
"DRAFT"
"VOIDED"
"AUTHORIZED"
"PAID"
"PARTIALLY_PAID"
urlstring
The public URL for the invoice to send to a customer to view or pay.
payment_collection_method enum
Valid values:
"send_invoice"
"charge_automatically"
When set to charging_automatically, an automated attempt will occur to pay this invoice using the default payment source attached to the contactcustomer. When set to send_invoice, an will email will be sent with this invoice to the contact/customer with payment instructions.
attachments array
sendboolean
organization_idstring
apply_amountnumber
applications array
What this credit memo was applied to (invoices/bills). Writable inline on create/update.
metadata array

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/accounting/5de520f96e439b002043d8dc/creditmemo',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
    updated_gte: '2026-10-23T20:23:33.239Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    contact_id: '',
    org_id: '',
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?