Credit Notes Field Reference

Use this reference when creating, approving, issuing, applying, or troubleshooting credit notes.

Credit Note Status Values

• draft
• pending_approval
• approved
• issued
• applied
• void

Reason Categories

• scope_change
• billing_error
• goodwill
• other

Required Create Fields

A credit note requires:

• At least one line item.
• Either an invoice or an account.

If invoice is provided, account is derived from the invoice. If account is provided without invoice, the credit note is standalone account credit.

Common Fields

Field	Type	Notes
Number	Text	Optional; can be generated from settings.
Invoice	Invoice select	Optional if account is used.
Account	Account select	Optional if invoice is used.
Currency	Currency code	Optional, 3-letter code.
Exchange rate	Decimal text	Optional.
Reason	Textarea	Optional or required based on settings.
Reason category	Select	Defaults to other.
Issued date	Date	Optional.
Line items	Line item list	Required, at least one.
Custom fields	Custom fields	Depends on organization configuration.

Line Item Source Values

• invoice
• manual

Line item fields include source type, invoice line item, description, and amount.

Lifecycle Actions

Action	Required field
Submit credit note	Optional note and approver.
Approve credit note	Optional comment.
Reject credit note	Reason required.
Void credit note	Reason required.
Apply credit note	Invoice and amount required.

Settings Fields

Credit note settings include:

• Credit notes enabled.
• Number prefix.
• Next credit note number.
• Allow number editing.
• Document title.
• Require reason.
• Auto-apply to source invoice.
• Approval enabled.
• Approver user ids.
• Default reason.

Copilot Notes

• "Enable credit module" should map to Credit Notes settings unless the product later adds a separate credit module.
• Do not claim credit notes were enabled until a confirmed write action exists and succeeds.
• For apply actions, require invoice and amount.
• For reject or void actions, require reason.

Related Docs

• Credit Notes
• Workflow Enable Credit Notes
• Invoices Field Reference
• Approvals Field Reference