JS Client API {Beta}
Search…
Retrieving Data
Adding Objects to Standard Resources
Supports the following resources : accounts, transactions, activities and contacts
Coming Soon (CPI V 16.0)
Adding a Single Object
- 1.The account field of the references object is mandatory (except for the accounts resource) and it supports UUID and InternalID.
- 2.The type field is mandatory for transactions and activities, while for accounts and contacts the type field is not mandatory - and if not provided the object will be created with the default type.
- 3.The type object should contain either type id or type name (when both are given the ID takes affect)
- 4.For transactions,activities and accounts - originAccount(transaction and activity only) and catalog fields can be assigned to define this type of relation, in the following restrictions:
- 1.originAccount - supports InternalID and UUID.
- 2.catalog - supports InternalID, UUID, and catalog Name.
- 3.catalog - is mandatory for accounts, activities and transactions that have multiple catalogs.
- 5.In case of objects that has Workflows transitions - the object will be created in the "new" status, with the New>>{Next Transition Step} initialized.
Example:
1
pepperi.app.<resource name>.add({
2
type: { InternalID: 1234 , Name : "Sales Order"} ,
3
references: { account: { UUID: "" } }, // Optional: {originAccount: { UUID: "" } // Optional: {catalog: { UUID: "" }
4
object: {GrandTotal: 567.5 ,TSASubject:"This Object was created with the client api"}
5
})
Copied!
Returns:
1
{
2
"success": true,
3
"id": "6e2803cd-b656-4d4f-8d21-f7cee7167350",
4
"status": "added",
5
"message": ""
6
}
Copied!
Last modified 2yr ago
Copy link
Contents
Adding a Single Object