erp-imports

suggestErpImportUseCases

Rank the org's inbound use cases against this file's columns — the input to the ranked picker ("matches 6 of your 7 columns"). Optional: skip this and call :validate directly when the use case is already known. Reads only the file's first row, not its data. Every eligible use case is returned, including ones matching nothing: the "nothing fits, pick anyway" view needs the full list. Highest match first. CSV only — an xlsx import fails with 400 rather than silently returning zero matches, which would look identical to "we checked and nothing matches".

post/v2/erp/imports/{importId}:suggest-use-cases

Path parameters

importIdstring required

Response

Ranked use-case suggestions

file_columnsinteger required

Columns in the file. Present even when suggestions is empty.

Changes

Changed in 2 of the 11 revisions of this API.13

  • a567add0c3f512See the full diff
    • removed the required property // from the response with the status

      response-required-property-removed

    • added the required property to the response with the status

      response-required-property-added

    • added the required property // to the response with the status

      response-required-property-added

    • endpoint added

      endpoint-added