BackOffice ERPInstall

Summary

Create a new credit note in the BackOffice ERP system by specifying required details such as the customer, date, number, currency, and items, along with optional billing and shipping information, discounts, notes, and terms.

Inputs

• clientid (required) — Customer ID supporting smart search—enter customer name, email, or keyword instead of numeric ID.
• date (required) — Credit Note date in YYYY-MM-DD format; leave empty for today.
• number (required) — Credit Note number; leave empty to auto-generate.
• currency (required) — Currency code as a number.
• newitems (required) — New items to be added on the credit note, provided as a string.
• billing_street — Billing street address.
• billing_city — Billing city name.
• billing_state — Billing state name.
• billing_zip — Billing ZIP code.
• billing_country — Billing country code as a number.
• shipping_street — Shipping street address.
• shipping_city — Shipping city name.
• shipping_state — Shipping state name.
• shipping_zip — Shipping ZIP code.
• shipping_country — Shipping country code as a number.
• discount_type — Discount type, specifying before_tax or after_tax.
• [Admin — Optional admin note.
• clientnote — Client notes.
• terms — Terms associated with the credit note.

Output shape

a single JSON object representing the created credit note or error details

The operation returns the newly created credit note data as JSON. Input fields requiring IDs support smart search allowing names or keywords; if multiple matches are found during search, the operation returns a respective message to refine the input. Omitting the Number input triggers auto-generation. Errors include missing required fields or ambiguous smart search results.

Examples

Example 1: Create a credit note with minimum required fields

Provide clientid as customer name or ID, date as YYYY-MM-DD, leave number empty to auto-generate, specify currency code, and details for newitems.