Payment synchronisation · How-to guide

Synchronise a partial payment to Sage safely

Detailed client guidance covering synchronise a partial payment to Sage safely, including prerequisites, exact controls, verification evidence, failure boundaries and safe recovery steps for the shipped Sage connector.

Audience: Administrators, finance staff and authorised integration operatorsPermission: SynchronizeModule v1.0.0
Jump to steps
Where to goSage Accounting Automation → Invoice Sync
Before you startConfirm the intended tenant, remote account or invoice context, and your Synchronize access. Keep credentials and tokens out of screenshots, tickets and exported evidence. If a previous write may have reached an external service, verify remote state before retrying.

What you’ll accomplish

Detailed client guidance covering synchronise a partial payment to Sage safely, including prerequisites, exact controls, verification evidence, failure boundaries and safe recovery steps for the shipped Sage connector. This article is intentionally scoped to the behaviour enforced or exposed by the supplied module and does not treat provider marketing features as implemented integration capabilities.

How the workflow fits together

The connector keeps native CRM records authoritative while mapping verified Contact, Sales Invoice and Contact Payment evidence in Sage. Queue, exception, API, reconciliation and compliance records are separate evidence layers, so each material action should be verified at both the native and remote sides.

Follow these steps

  1. Open Sage Accounting Automation → Invoice Sync.
  2. Confirm you are in the intended tenant and connected business and that your role has the required Synchronize access.
  3. Confirm the native payment belongs to the intended mapped invoice and that the applied amount is correct.
  4. Verify the configured bank/payment mapping.
  5. Run or allow the payment sync once.
  6. Confirm the remote payment/allocation is linked to the intended invoice for the exact amount.
  7. If evidence is incomplete, treat it as unresolved rather than successful.

Fields and decisions to review

This guide’s focusDetailed client guidance covering synchronise a partial payment to Sage safely, including prerequisites, exact controls, verification evidence, failure boundaries and safe recovery steps for the shipped Sage connector.
Invoice linkA payment must be allocated to the intended mapped invoice, not only created as an unlinked cash movement.
Exact evidenceSuccess requires a remote payment/allocation identifier with the exact amount or an independently verified exact outstanding-balance reduction.
IdempotencyLocks, stored remote identifiers and duplicate checks prevent a retry from creating the same accounting payment twice.
Partial amountsPartial payments are supported only when the applied amount and remaining balance can be verified.
Correction boundaryPayment updates/deletions are not converted into blind destructive remote actions after an ambiguous write.
Remote payment evidenceexplicit Contact Payment allocation evidence against the intended Sales Invoice, or an independently verified exact outstanding-balance reduction

How to confirm it worked

Reopen the native record and the relevant integration history/register. Confirm the stored remote accounting identifier, exact amount/status, latest timestamps and the expected audit or reconciliation evidence. If the provider-side state cannot be independently verified, keep the task unresolved and use the controlled exception or troubleshooting flow.

Questions clients commonly ask

What proves the payment was allocated?Explicit contact payment allocation evidence against the intended sales invoice, or an independently verified exact outstanding-balance reduction.
What should I verify before I trust the result?Verify the native record, the mapped remote record, the stored remote identifier, the current status/amount and the audit or history evidence. A success message alone is not the accounting evidence.
Should I press the action again after a timeout?Not until you have checked the remote accounting service and the Exceptions/API evidence. A timeout can occur after the remote side accepted a non-idempotent write, so a blind retry can create a duplicate.
Does the connector replace the native CRM record?No. Native clients, invoices and payments remain the operational source records. The connector records mappings, remote evidence and controlled reconciliation around them.
What should I include in a support case?Include the native record ID, remote ID if known, date/time, action, exact visible error and request/audit identifier. Never send client secrets, access tokens, refresh tokens or authorization headers.

Technical basis for this guidance

This guide was checked against the supplied module code paths: controllers/Sage_accounting_automation.php; models/Sage_accounting_automation_model.php; libraries/Sage_api_client.php; libraries/Sage_reconciliation_service.php; libraries/Sage_document_import_service.php; views/admin; install.php; docs/FEATURE_MATRIX.md. It documents shipped behaviour, validation, routes and evidence controls; it does not claim successful live provider network calls from offline inspection.

Controls, checks and common mistakes

  • Work in the intended tenant and remote accounting/business context.
  • Do not paste credentials, access tokens, refresh tokens or private keys into tickets or notes.
  • Do not bypass a missing mapping, validation error, permission gate, duplicate check or remote-verification requirement.
  • Do not repeat a non-idempotent write until you know whether the previous request reached the remote service.
  • Keep native record, remote evidence and audit/history state aligned before closing the task.
Provider and accounting boundaryThe integration fails closed when required mapping, remote identity, validation, concurrency or verification evidence is missing. Do not bypass a blocker by editing unrelated records or repeating an uncertain write.