@celigo/api-specs 0.2.183 → 0.2.184
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/import.yml +39 -1
- package/dist/tool.yml +39 -1
- package/package.json +1 -1
- package/schemas.json +1 -1
package/dist/import.yml
CHANGED
|
@@ -4454,7 +4454,11 @@ components:
|
|
|
4454
4454
|
description: When true, the value is a NetSuite internal ID reference.
|
|
4455
4455
|
isKey:
|
|
4456
4456
|
type: boolean
|
|
4457
|
-
description:
|
|
4457
|
+
description: |-
|
|
4458
|
+
When true, this field is a key for matching the record's existing sublist lines: a
|
|
4459
|
+
mapped line updates the one existing line whose key fields hold the same values. `lists`
|
|
4460
|
+
says which records match lines, the keys used when no field sets `isKey`, and what a
|
|
4461
|
+
line that matches no line, or several, does.
|
|
4458
4462
|
immutable:
|
|
4459
4463
|
type: boolean
|
|
4460
4464
|
description: When true, this field is only set on record creation, not on updates.
|
|
@@ -4630,6 +4634,40 @@ components:
|
|
|
4630
4634
|
description: Field mappings for each column in the sublist.
|
|
4631
4635
|
description: |
|
|
4632
4636
|
Sublist (line-item) mappings. Each entry maps source data to a NetSuite sublist.
|
|
4637
|
+
|
|
4638
|
+
Each mapped line updates the one existing line whose key fields hold the same values: its
|
|
4639
|
+
`isKey` fields, or, with none, the sublist's default key. The existing lines are the stored
|
|
4640
|
+
record's on an update, and on a transform (`Created From`: the body field
|
|
4641
|
+
`celigo_nlobjTransformId` holds the source transaction's internal id) the lines the transform
|
|
4642
|
+
fills in. Default keys:
|
|
4643
|
+
|
|
4644
|
+
- the item (`item`, else `itemkey` or `itemname`) on item fulfillments, item receipts,
|
|
4645
|
+
invoices, cash sales, cash refunds, return authorizations, bin worksheets, inbound shipment
|
|
4646
|
+
receipts and inventory counts, and on an assembly build's `component` sublist;
|
|
4647
|
+
- the applied transaction (`refnum`) on the `apply`, `credit` and `deposit` sublists of
|
|
4648
|
+
customer and vendor payments, credit memos, vendor credits and customer refunds;
|
|
4649
|
+
- `docnumber` on a deposit's `payment` sublist;
|
|
4650
|
+
- `vendor` and `language` on an item record's `itemvendor` and `translations` sublists.
|
|
4651
|
+
|
|
4652
|
+
A sublist with neither, such as a sales order's or purchase order's `item`, matches nothing, so
|
|
4653
|
+
an update adds every mapped line after the existing ones. Two matching lines fail the record
|
|
4654
|
+
with `MULTIPLE_LINES_WITH_SAME_KEYS` ("Multiple lines found with keys item=<value> ..."). A
|
|
4655
|
+
line that matches none is added as a new line, which an item fulfillment's `item` sublist
|
|
4656
|
+
refuses with `SSS_INVALID_SUBLIST_OPERATION`: its lines are its order's.
|
|
4657
|
+
x-celigo-ai-guidance:
|
|
4658
|
+
- |-
|
|
4659
|
+
To make an update replace a sublist's lines, also map the body field
|
|
4660
|
+
`celigo_replaceAllLines_<sublist id>` (for example `celigo_replaceAllLines_item`) to `true`:
|
|
4661
|
+
the existing lines no mapped line matched are removed, then the mapped lines are written. Where
|
|
4662
|
+
lines can't be removed it clears them instead: `itemreceive` false on an item fulfillment or
|
|
4663
|
+
item receipt, `apply` false on an `apply` sublist. On a sublist with no `isKey` field and no
|
|
4664
|
+
default key every existing line is unmatched, so all are replaced; with a default key, the lines
|
|
4665
|
+
it matches stay.
|
|
4666
|
+
- |-
|
|
4667
|
+
Key an update on a value each line holds once: a line id the record's create wrote to a line
|
|
4668
|
+
field, or, on a fulfillment, the order line's id mapped to `orderline`. Keying on the item fails
|
|
4669
|
+
with `MULTIPLE_LINES_WITH_SAME_KEYS` when an order holds the same item on two lines, and records
|
|
4670
|
+
that already hold repeated lines fail the same way once a key is set.
|
|
4633
4671
|
x-celigo-agent:
|
|
4634
4672
|
- mapping
|
|
4635
4673
|
lookups:
|
package/dist/tool.yml
CHANGED
|
@@ -16335,7 +16335,11 @@ components:
|
|
|
16335
16335
|
description: When true, the value is a NetSuite internal ID reference.
|
|
16336
16336
|
isKey:
|
|
16337
16337
|
type: boolean
|
|
16338
|
-
description:
|
|
16338
|
+
description: |-
|
|
16339
|
+
When true, this field is a key for matching the record's existing sublist lines: a
|
|
16340
|
+
mapped line updates the one existing line whose key fields hold the same values. `lists`
|
|
16341
|
+
says which records match lines, the keys used when no field sets `isKey`, and what a
|
|
16342
|
+
line that matches no line, or several, does.
|
|
16339
16343
|
immutable:
|
|
16340
16344
|
type: boolean
|
|
16341
16345
|
description: When true, this field is only set on record creation, not on updates.
|
|
@@ -16511,6 +16515,40 @@ components:
|
|
|
16511
16515
|
description: Field mappings for each column in the sublist.
|
|
16512
16516
|
description: |
|
|
16513
16517
|
Sublist (line-item) mappings. Each entry maps source data to a NetSuite sublist.
|
|
16518
|
+
|
|
16519
|
+
Each mapped line updates the one existing line whose key fields hold the same values: its
|
|
16520
|
+
`isKey` fields, or, with none, the sublist's default key. The existing lines are the stored
|
|
16521
|
+
record's on an update, and on a transform (`Created From`: the body field
|
|
16522
|
+
`celigo_nlobjTransformId` holds the source transaction's internal id) the lines the transform
|
|
16523
|
+
fills in. Default keys:
|
|
16524
|
+
|
|
16525
|
+
- the item (`item`, else `itemkey` or `itemname`) on item fulfillments, item receipts,
|
|
16526
|
+
invoices, cash sales, cash refunds, return authorizations, bin worksheets, inbound shipment
|
|
16527
|
+
receipts and inventory counts, and on an assembly build's `component` sublist;
|
|
16528
|
+
- the applied transaction (`refnum`) on the `apply`, `credit` and `deposit` sublists of
|
|
16529
|
+
customer and vendor payments, credit memos, vendor credits and customer refunds;
|
|
16530
|
+
- `docnumber` on a deposit's `payment` sublist;
|
|
16531
|
+
- `vendor` and `language` on an item record's `itemvendor` and `translations` sublists.
|
|
16532
|
+
|
|
16533
|
+
A sublist with neither, such as a sales order's or purchase order's `item`, matches nothing, so
|
|
16534
|
+
an update adds every mapped line after the existing ones. Two matching lines fail the record
|
|
16535
|
+
with `MULTIPLE_LINES_WITH_SAME_KEYS` ("Multiple lines found with keys item=<value> ..."). A
|
|
16536
|
+
line that matches none is added as a new line, which an item fulfillment's `item` sublist
|
|
16537
|
+
refuses with `SSS_INVALID_SUBLIST_OPERATION`: its lines are its order's.
|
|
16538
|
+
x-celigo-ai-guidance:
|
|
16539
|
+
- |-
|
|
16540
|
+
To make an update replace a sublist's lines, also map the body field
|
|
16541
|
+
`celigo_replaceAllLines_<sublist id>` (for example `celigo_replaceAllLines_item`) to `true`:
|
|
16542
|
+
the existing lines no mapped line matched are removed, then the mapped lines are written. Where
|
|
16543
|
+
lines can't be removed it clears them instead: `itemreceive` false on an item fulfillment or
|
|
16544
|
+
item receipt, `apply` false on an `apply` sublist. On a sublist with no `isKey` field and no
|
|
16545
|
+
default key every existing line is unmatched, so all are replaced; with a default key, the lines
|
|
16546
|
+
it matches stay.
|
|
16547
|
+
- |-
|
|
16548
|
+
Key an update on a value each line holds once: a line id the record's create wrote to a line
|
|
16549
|
+
field, or, on a fulfillment, the order line's id mapped to `orderline`. Keying on the item fails
|
|
16550
|
+
with `MULTIPLE_LINES_WITH_SAME_KEYS` when an order holds the same item on two lines, and records
|
|
16551
|
+
that already hold repeated lines fail the same way once a key is set.
|
|
16514
16552
|
x-celigo-agent:
|
|
16515
16553
|
- mapping
|
|
16516
16554
|
lookups:
|
package/package.json
CHANGED