Actions59
- Document Actions
- Client Actions
- Supplier Actions
- Item (Catalog) Actions
- Expense Actions
- Payment Actions
- Transaction (עסקה) Actions
- Recurring Payment (הוראת קבע) Actions
- Retainer (ריטיינר) Actions
- Accounting Actions
- Business Actions
Retainer (ריטיינר) → Create
AI-generatedSummary
Creates a recurring retainer document schedule in Morning, with its dates, issue interval, document details, and payment settings. Each cycle issues a document using the configured client, income lines, and optional document settings.
Inputs
- Start Date (required) — First issue date; sent as YYYY-MM-DD.
- End Date — Last issue date; leave empty for no limit.
- Interval — Issue frequency: monthly, every two months, quarterly, semi-annually, or yearly. Defaults to monthly.
- Document Type (required) — Document issued each cycle: tax invoice and receipt, tax invoice, proforma invoice, or receipt. Defaults to tax invoice and receipt.
- Language — Document language, Hebrew or English; defaults to Hebrew.
- Currency — ISO 4217 currency code for document totals; defaults to ILS.
- VAT Type — How line prices relate to VAT: before VAT, VAT included, or VAT exempt. Defaults to VAT included.
- Client (JSON) — Client object, such as {"id":"
"} or an object to add a client. - Income Lines (JSON Array) — Document line items. Prices must match the selected VAT type.
- Payment Lines (JSON Array) — Optional payment lines; an empty array is omitted.
- Document Remarks — Optional free-text notes on each issued document.
- Document Title — Optional title on each issued document.
- Discount (JSON) — Optional discount object, for example {"type":"percentage","amount":10}.
- Signed — Whether issued documents are digitally signed; defaults to true.
- Round Amounts — Whether to round document totals; defaults to false.
- Attachment — Whether issued documents include an attachment; defaults to false.
- Skip Date Validation — Whether to skip document date validation; defaults to false.
- Footer — Optional footer text for issued documents.
- Email Content — Optional email body sent with each document.
- Payment Request Data (JSON) — Optional payment-request configuration.
- Payment Terms — Payment terms for issued documents, from immediate to Net 120; defaults to immediate.
- Description Rule — Description used each cycle. Supports "my" for month-year, "pmy" for previous month-year, or free text; defaults to "my".
- Request Options — Optional request settings for batching, SSL certificate validation, proxy, and timeout.
Output shape
A single API response for the created retainer.
The supplied source pack shows no operation implementation body or response mapping, so the precise response fields are not established.
Examples
Example 1: Set up a monthly tax invoice and receipt retainer for a client, starting on a specified date with income lines and no end date.
Choose the client, document type, start date, interval, and line items; optionally configure VAT, payment terms, and email content.