Schemas
CreateCaseFromTransactionsRequest
Case header for the investigation case to create. These fields map to the Theft Case API. See that reference for the authoritative and complete field list. This endpoint derives the case's involved persons and case items from the transactions' employees and line items. It ignores any value you supply here for those collections.
Frontier transactions to snapshot and link. Must contain at least one entry.
TheftCaseInput
investigationTypeInvestigation type picklist value (e.g. External Theft, Internal Theft). Immutable after create.
incidentDateDate of the incident (YYYY-MM-DD).
statusCase status picklist value (Open, Closed, Pending Assignment, Pending Approval). narrative is required when Closed.
incidentTypeIncident type picklist value.
primaryLocationIdSalesforce Id of the primary location record.
narrativeFree-text narrative description of the incident.
initialCaseValueInitial estimated value of the case. Immutable after create.
investigatorIdSalesforce User Id of the assigned investigator.
TransactionSnapshot
transactionIdFrontier-side transaction identifier (snapshot value, not a Salesforce Id). Unique per case.
transactionNumbertransactionDatetransactionTotalrelatedEmployeeIdFrontier-side employee identifier. The API matches it as a Salesforce Contact Id to resolve a canonical Person. When a Contact has no canonical Person, the API provisions one from the Contact's name, so a 201 means every employee named on the payload is linked.
The API rejects these values:
- A value that is not a well-formed Salesforce Id —
400 INVALID_CASE_PAYLOAD. - A Contact the API cannot provision a Person for —
400 INVALID_CASE_PAYLOAD. - An Id that matches no Contact —
404 REFERENCE_NOT_FOUND.
frontierUrlPOS line items on the transaction.
LineItem
skuStock keeping unit. Aggregated case-insensitively and used to provision or find the canonical Item.
quantityunitValuePer-unit value at the time of the incident.
upcserialNumbercategoryunitTypedescriptionCreateCaseFromTransactionsResponse
caseIdSalesforce Id of the created investigation case.
caseUrlAbsolute URL to the created case record.
linkedTransactionCountNumber of transactions snapshotted and linked.
linkedInvolvedPersonCountDistinct employees resolved to Persons and attached as involved persons.
skippedEmployeeCountRetained for wire compatibility, and always 0. An employee that cannot be resolved to a Person fails the request instead.
linkedCaseItemCountDistinct line-item SKUs provisioned as Items and attached as case items.
LinkedTransaction
transactionIdtransactionNumbertransactionDatetransactionTotalrelatedEmployeeIdFrontier-side employee identifier (snapshot value).
frontierUrlBadgeMap
caseIdSalesforce Id of the linked case.
caseUrlAbsolute URL to the linked case record.