u
This commit is contained in:
36
API.order.md
36
API.order.md
@@ -36,6 +36,42 @@ const order = await store.order.create(42, { number: 'B-2026-001', date: '2026-0
|
||||
// => { id, number, type, entityId, externalNumber, date, lines: [...] }
|
||||
```
|
||||
|
||||
## `order.createFromQuote`
|
||||
|
||||
*Source: `src/store/order/createFromQuote.js`*
|
||||
|
||||
Creates a new sales order from an existing quote for the user's selected company. Copies lines, entity, and external number from the quote unless explicitly overridden. If order number is omitted, it is auto-allocated from the 'order' number sequence.
|
||||
|
||||
**Parameters**
|
||||
|
||||
| Name | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| `googleAuthId` | `number` | The id of the Google auth user. |
|
||||
| `quoteId` | `number` | The id of the source quote. |
|
||||
| `[body]` | `object` | Optional overrides for the order. |
|
||||
| `[body.number]` | `string` | The order number; auto-allocated from sequence if omitted. |
|
||||
| `[body.date]` | `string` | The order date; defaults to current date if omitted. |
|
||||
| `[body.createdAt]` | `string` | Creation timestamp; defaults to current time if omitted. |
|
||||
| `[body.entityId]` | `number` | Customer entity id override; defaults to quote's entityId. |
|
||||
| `[body.externalNumber]` | `string` | Customer reference override; defaults to quote's externalNumber. |
|
||||
| `[body.lines]` | `Array<{sku?: string, name?: string, pu?: number, amount: number, net: number, rebate?: number, taxrate: number, comment?: string|null}>` | Lines override; defaults to quote's lines. |
|
||||
| `[tx]` | `object` | Optional transaction to run within. |
|
||||
|
||||
**Returns**
|
||||
|
||||
`Promise<{id: number, number: string, type: string, entityId: number|null, externalNumber: string|null, date: string, lines: Array<{id: number, sku: string|null, name: string|null, pu: number, amount: number, net: number, rebate: number, taxrate: number, comment: string|null}>}>` — The created order.
|
||||
|
||||
**Throws**
|
||||
|
||||
`Error` — If the quote is not found, or the order is invalid.
|
||||
|
||||
**Example**
|
||||
|
||||
```js
|
||||
const order = await store.order.createFromQuote(42, 10);
|
||||
// => { id, number, type: 'order', entityId, externalNumber, date, lines: [...] }
|
||||
```
|
||||
|
||||
## `order.delete`
|
||||
|
||||
*Source: `src/store/order/delete.js`*
|
||||
|
||||
Reference in New Issue
Block a user