Skip to content

feat: allow date/reference updates on authorised credit notes #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rathga wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: allow date/reference updates on authorised credit notes #195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions src/handlers/update-xero-credit-note.handler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,23 @@ export async function updateXeroCreditNote(

const creditNoteStatus = existingCreditNote?.status;

// Only allow updates to DRAFT credit notes
if (creditNoteStatus !== CreditNote.StatusEnum.DRAFT) {
// DRAFT credit notes can be fully updated. AUTHORISED credit notes only
// accept changes to the date and reference; everything else is rejected.
if (creditNoteStatus === CreditNote.StatusEnum.AUTHORISED) {
if (lineItems || contactId) {
return {
result: null,
isError: true,
error:
"Only the date and reference of an authorised credit note can be updated. " +
"Line items and contact cannot be changed.",
};
}
} else if (creditNoteStatus !== CreditNote.StatusEnum.DRAFT) {
return {
result: null,
isError: true,
error: `Cannot update credit note because it is not a draft. Current status: ${creditNoteStatus}`,
error: `Cannot update credit note because its status is ${creditNoteStatus}. Only draft credit notes can be fully updated; authorised credit notes can have their date and reference updated.`,
};
}

Expand Down
4 changes: 3 additions & 1 deletion src/tools/update/update-credit-note.tool.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ const lineItemSchema = z.object({

const UpdateCreditNoteTool = CreateXeroTool(
"update-credit-note",
"Update a credit note in Xero. Only works on draft credit notes.\
"Update a credit note in Xero. Draft credit notes can be fully updated.\
Authorised (approved) credit notes can only have their date and reference updated;\
to change anything else, the credit note must be a draft.\
All line items must be provided. Any line items not provided will be removed. Including existing line items.\
Do not modify line items that have not been specified by the user.\
When a credit note is updated, a deep link to the credit note in Xero is returned.\
Expand Down