feat!: add overpayments webhook endpoint and schema - #840
Draft
MikeLiuty wants to merge 1 commit into
Draft
Conversation
BREAKING CHANGE: adds OVERPAYMENT as a new eventCategory oneOf value in xero-webhooks.yaml. Existing strict schema validators may reject this new enum value in webhook payloads; this is expected since subscribers must explicitly opt in to overpayment events.
MikeLiuty
force-pushed
the
ecoam-5839-add-overpaymen-webhook-specs
branch
from
August 18, 2026 00:36
73b9fbe to
69febfc
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the Overpayments webhook to xero-webhooks.yaml, including the OVERPAYMENT event category, OverpaymentWebhookEvent schema, and a create-event example aligned with the Credit Notes and Prepayment webhook pattern.
Changes
New webhooks/overpayment endpoint (publishOverpaymentEvent)
OverpaymentWebhookEvent with data.Type, data.Status, and data.UpdatedDateUTCString
OVERPAYMENT added to eventCategory enum
https://xero.atlassian.net/browse/ECOAM-5839