Skip to main content

Reconcile Sales Credit Invoice Application

POST 
/api/sales-credits/:salesCredit/reconcile-invoice-application

Re-checks, in the connected accounting system, whether this credit note is still applied to the invoice it was raised against. While that application is recorded in Xero or QuickBooks Online, the credit's amounts can't be edited and it can't be deleted. Remove the allocation in the accounting system first (Xero: delete the credit note allocation; QuickBooks Online: delete or void the payment that links the credit memo to the invoice), then call this endpoint.

Required scope: orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token. Permission: returns.update.

Behaviour:

  • Each recorded application is looked up in the accounting system.
  • removed: the system no longer applies it. SKU.io forgets the recorded state and the credit can be edited again; the credit's current amount is re-applied on the next accounting sync (within about 15 minutes).
  • still_applied: the system still applies it; nothing changes.
  • unverifiable: the system could not be asked (connection unavailable, document no longer linked); nothing changes.

Response fields: released (true when the credit can now be edited), edit_blocked_reason (why not, or null), and one applications entry per recorded application with allocation_id, sales_invoice_id, amount, provider, state and message. A credit with no recorded application returns released: true and an empty applications list.

Request​

Responses​

OK

Response Headers
    Content-Type