Retrieving Transaction Lines

Data Retrieval Methods

Get Single Transaction Line by Unique Key

  • Description: Retrieves a single Transaction Line using the get function, with Line UUID as the only supported key.

  • Syntax:

    pepperi.api.transactionLines.get({
  key: { UUID: "<UUID>" },
  fields: [<string array of relevant field names>]
});

  • Example:

    pepperi.api.transactionLines.get({
  key: { UUID: "aefb523e-74ac-4041-8bb1-a76a3b5e78d8" },
  fields: ["UnitsQuantity", "Item.ExternalID"]
});

  • Returns:

    {
  "success": true,
  "object": {
    "UUID": "aefb523e-74ac-4041-8bb1-a76a3b5e78d8",
    "UnitsQuantity": 34,
    "Item.ExternalID": "ABCD123"
  }
}

Search List of Transaction Lines by Filter

  • Description: Retrieves multiple Transaction Lines using the search function with a filter, sorting, page size, and page number.

  • Syntax:

  • Example:

  • Returns:

Search List of Transaction Lines by Transaction Filter and Transaction Lines Filter

  • Description: Retrieves Transaction Lines from transactions not yet loaded into memory using the search function with separate transactionFilter and filter parameters.

  • Purpose: Enables fetching lines from unloaded transactions efficiently.

  • Syntax:

  • Example:

  • Returns:

PreviousRetrieving Items in Transaction ScopeNextADAL

Last updated

Was this helpful?