Perfex CRM APIInstall

Summary

Create a new invoice in Perfex CRM by specifying required invoice details such as client ID, invoice number, date, currency, items, subtotal, total, billing address, and allowed payment modes, with optional additional invoice fields.

Inputs

• Client ID (required) — The ID of the customer for whom the invoice is being created.
• Number (required) — The invoice number.
• Date (required) — The invoice date in YYYY-MM-DD format.
• Currency (required) — The currency ID for the invoice.
• New Items (JSON) (required) — A JSON array string representing new items to add to the invoice.
• Subtotal (required) — Subtotal amount calculated based on item quantities, rates, and taxes.
• Total (required) — Total amount calculated based on subtotal, discounts, and adjustments.
• Billing Street (required) — Street address used for billing.
• Allowed Payment Modes (JSON) (required) — A JSON array string specifying allowed payment modes for the invoice.
• Additional Fields — Optional fields for invoice such as admin note, billing city, billing country, billing state, billing zip, client note, discount type, due date, recurring schedule, shipping address details, sale agent ID, tags, terms and others.

Output shape

a single JSON object representing the created invoice record returned from the Perfex CRM API

The output contains all standard and additional invoice details as returned by the API. Errors during creation will throw exceptions unless 'Continue On Fail' is enabled, which returns error details for each item.

Examples

Example 1: Create invoice with required and selected optional fields

Populate Client ID, Number, Date, Currency, New Items (JSON), Subtotal, Total, Billing Street, Allowed Payment Modes (JSON), and optional Additional Fields like Billing City and Tags.