Update a creditmemo

PUT/accounting/{connection_id}/creditmemo/{id}

Parameters

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
idstring required
ID of the Creditmemo

Payload

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

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
due_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
paid_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
refunded_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
cancelled_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
posted_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
total_amountnumberNo
paid_amountnumberNo
refund_amountnumberNo
tax_amountnumberNo
discount_amountnumberNo
balance_amountnumberNo
creditmemo_numberstringNoExternal identifier for this invoice
contact_idstringNo(reference to AccountingContact)
invoice_idstringNo(reference to AccountingInvoice)
currencystringNo
notesstringNo
refund_reasonstringNo
lineitemsAccountingLineitem[]No
lineitems[].idstringNo
lineitems[].created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
lineitems[].updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
lineitems[].refunded_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
lineitems[].total_amountnumberNounit_quantity * unit_amount + tax_amount
lineitems[].refund_amountnumberNo
lineitems[].discount_amountnumberNo
lineitems[].tax_amountnumberNo
lineitems[].item_idstringNo(reference to CommerceItem)
lineitems[].unit_amountnumberNo
lineitems[].unit_quantitynumberNo
lineitems[].item_skustringNo
lineitems[].item_namestringNo
lineitems[].item_descriptionstringNo
lineitems[].notesstringNo
lineitems[].taxrate_idstringNo
lineitems[].account_idstringNo(reference to AccountingAccount)
lineitems[].category_idsstring[]No(reference to AccountingCategory)
lineitems[].locationsAccountingReference[]No
lineitems[].locations[].idstringNo
lineitems[].locations[].namestringNo
lineitems[].item_variantsAccountingReference[]No
lineitems[].item_variants[].idstringNo
lineitems[].item_variants[].namestringNo
lineitems[].feesAccountingFee[]No
lineitems[].fees[].typeenumYesUnified fee category Values: TAX, DISCOUNT, PROMOTION, SHIPPING, GIFT_WRAP, COD, SURCHARGE, TIP, SERVICE_CHARGE, OTHER
lineitems[].fees[].original_typestringNoThe provider's original fee label, e.g. "VAT" or a shipping carrier name
lineitems[].fees[].amountnumberYes
lineitems[].fees[].currencystringNoISO 4217 currency code, e.g. USD
lineitems[].contact_idstringNo(reference to AccountingContact)
lineitems[].project_idstringNoref -> AccountingProject; the project this line is coded to (reference to TaskProject)
lineitems[].exchange_ratenumberNoThe exchange rate applied to this line, for multi-currency documents
lineitems[].is_billablebooleanNoTrue when the line is rebillable to a customer
statusenumNoValues: DRAFT, VOIDED, AUTHORIZED, PAID, PARTIALLY_PAID, PARTIALLY_REFUNDED, REFUNDED, SUBMITTED, DELETED, OVERDUE
urlstringNoThe public URL for the invoice to send to a customer to view or pay.
payment_collection_methodenumNoWhen 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. Values: send_invoice, charge_automatically
attachmentsAccountingAttachment[]No
attachments[].idstringNo
attachments[].download_urlstringNo
attachments[].namestringNo
attachments[].mime_typestringNo
sendbooleanNo
organization_idstringNo
apply_amountnumberNo
applicationsAccountingCreditApplication[]NoWhat this credit memo was applied to (invoices/bills). Writable inline on create/update.
applications[].object_typeenumNoThe type of object this credit was applied to Values: INVOICE, BILL
applications[].object_idstringNoThe id of the object this credit was applied to
applications[].amountnumberNoThe amount of credit applied to this object
applications[].applied_atstring (date-time)NoDate and time when the credit was applied, in ISO 8601 format and UTC (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
metadataAccountingMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

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: 'PUT',
  url: 'https://api.unified.to/accounting/5de520f96e439b002043d8dc/creditmemo/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

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