Jump to

• Request
• Response

Get all transaction metrics by file

get

/api/erp/integrations/resources/v1/{locale}/files/{id}/transactionCounts

Returns the count of transactions processed within a given file.

Request

Path Parameters

• id(required): string
  The unique identifier of the file.

  Example:

  324108415901929470

• locale(required): string
  The locale to which the file is being uploaded.

  Example:

  en-us

Query Parameters

• flowName: string
  The name of the flow for which the service is being invoked.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Simple JSON containing transaction Counts for a particular file

Body ()

Root Schema : TransactionCount

Type: object

Show Source

• fileID: string
  The unique identifier of the file.
• flowName: string
  The name of the flow for which the service is being invoked.
• headerCount: object HeaderCounts
• lineCount: object LineCounts

{
    "properties":{
        "fileID":{
            "description":"The unique identifier of the file.",
            "type":"string"
        },
        "flowName":{
            "description":"The name of the flow for which the service is being invoked.",
            "type":"string"
        },
        "headerCount":{
            "description":"The count of transactions processed for a file.",
            "$ref":"#/components/schemas/HeaderCounts"
        },
        "lineCount":{
            "description":"The count of transaction lines processed for a file.",
            "$ref":"#/components/schemas/LineCounts"
        }
    },
    "type":"object"
}

Nested Schema : HeaderCounts

Type: object

Show Source

• totalHeaderCount: integer (int64)
• totalHeaderErrorInLine: integer (int64)
• totalHeaderInError: integer (int64)
• totalHeaderInProcessing: integer (int64)
• totalHeaderInWarning: integer (int64)
• totalHeaderProcessed: integer (int64)

{
    "properties":{
        "totalHeaderCount":{
            "format":"int64",
            "type":"integer"
        },
        "totalHeaderInError":{
            "format":"int64",
            "type":"integer"
        },
        "totalHeaderProcessed":{
            "format":"int64",
            "type":"integer"
        },
        "totalHeaderInWarning":{
            "format":"int64",
            "type":"integer"
        },
        "totalHeaderErrorInLine":{
            "format":"int64",
            "type":"integer"
        },
        "totalHeaderInProcessing":{
            "format":"int64",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : LineCounts

Type: object

Show Source

• totalLineCount: integer (int64)
• totalLineErrorInHeaders: integer (int64)
• totalLineErrorInRelatedLine: integer (int64)
• totalLineIgnored: integer (int64)
• totalLineInError: integer (int64)
• totalLineProcessed: integer (int64)

{
    "properties":{
        "totalLineCount":{
            "format":"int64",
            "type":"integer"
        },
        "totalLineInError":{
            "format":"int64",
            "type":"integer"
        },
        "totalLineProcessed":{
            "format":"int64",
            "type":"integer"
        },
        "totalLineErrorInRelatedLine":{
            "format":"int64",
            "type":"integer"
        },
        "totalLineErrorInHeaders":{
            "format":"int64",
            "type":"integer"
        },
        "totalLineIgnored":{
            "format":"int64",
            "type":"integer"
        }
    },
    "type":"object"
}

Back to Top