Duplicate Consistency Job

Duplicate Consistency Job - Get

HTTP Request

GET /api/v1/sap-posting-bot/duplicate-consistency-check/jobs/{id}

Interactive Demo

📋 Description: Retrieves the status and details of a specific duplicate consistency check job by its unique identifier, facilitating the validation of ledger entries and ensuring the integrity of financial records within the General Ledger.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDuplicateConsistencyJobDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "taskCount": 0,
    "failedTaskCount": 0,
    "doneTaskCount": 0,
    "inProgressTaskCount": 0,
    "cancelledTaskCount": 0,
    "errorMessage": "string",
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "executor": "SCHEDULER",
    "scheduleJobId": 0,
    "filter": {
      "fiscalYear": 0,
      "fiscalPeriod": 0,
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "companyFilterType": "ALL",
      "companies": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "duplicateConsistencyToolTypes": [
        "DUPLICATE_POSTINGS"
      ]
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Duplicate Consistency Job - Update

HTTP Request

PUT /api/v1/sap-posting-bot/duplicate-consistency-check/jobs/{id}

Interactive Demo

📋 Description: Updates the consistency check status for a specified duplicate job in the General Ledger, ensuring accurate ledger entries and maintaining the integrity of financial records associated with transactions and accounts.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	DuplicateConsistencyJobDto	true	Request body containing the financial record details necessary for performing a duplicate consistency check on a specific ledger entry transaction identified by the provided job ID.

Body Parameters

{
  "id": 0,
  "taskCount": 0,
  "failedTaskCount": 0,
  "doneTaskCount": 0,
  "inProgressTaskCount": 0,
  "cancelledTaskCount": 0,
  "errorMessage": "string",
  "erpSystem": {
    "id": 0,
    "displayId": "string"
  },
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z",
  "status": "CREATED",
  "executor": "SCHEDULER",
  "scheduleJobId": 0,
  "filter": {
    "fiscalYear": 0,
    "fiscalPeriod": 0,
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "companyFilterType": "ALL",
    "companies": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "duplicateConsistencyToolTypes": [
      "DUPLICATE_POSTINGS"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDuplicateConsistencyJobDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "taskCount": 0,
    "failedTaskCount": 0,
    "doneTaskCount": 0,
    "inProgressTaskCount": 0,
    "cancelledTaskCount": 0,
    "errorMessage": "string",
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "executor": "SCHEDULER",
    "scheduleJobId": 0,
    "filter": {
      "fiscalYear": 0,
      "fiscalPeriod": 0,
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "companyFilterType": "ALL",
      "companies": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "duplicateConsistencyToolTypes": [
        "DUPLICATE_POSTINGS"
      ]
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Duplicate Consistency Job - Create Or Update

HTTP Request

PUT /api/v1/sap-posting-bot/duplicate-consistency-check/jobs/createOrUpdate

Interactive Demo

📋 Description: Creates or updates a duplicate consistency check job for ledger entries, ensuring the accuracy of financial records and transactions within the General Ledger. This operation helps maintain the integrity of account data by identifying and managing duplicate entries.

Parameters

Name	In	Type	Required	Description
body	body	DuplicateConsistencyJobDto	true	Request body containing the ledger entry details, including transaction information, account identifiers, and associated financial record data for creating or updating duplicate consistency check jobs.

Body Parameters

{
  "id": 0,
  "taskCount": 0,
  "failedTaskCount": 0,
  "doneTaskCount": 0,
  "inProgressTaskCount": 0,
  "cancelledTaskCount": 0,
  "errorMessage": "string",
  "erpSystem": {
    "id": 0,
    "displayId": "string"
  },
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z",
  "status": "CREATED",
  "executor": "SCHEDULER",
  "scheduleJobId": 0,
  "filter": {
    "fiscalYear": 0,
    "fiscalPeriod": 0,
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "companyFilterType": "ALL",
    "companies": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "duplicateConsistencyToolTypes": [
      "DUPLICATE_POSTINGS"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDuplicateConsistencyJobDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "taskCount": 0,
    "failedTaskCount": 0,
    "doneTaskCount": 0,
    "inProgressTaskCount": 0,
    "cancelledTaskCount": 0,
    "errorMessage": "string",
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "executor": "SCHEDULER",
    "scheduleJobId": 0,
    "filter": {
      "fiscalYear": 0,
      "fiscalPeriod": 0,
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "companyFilterType": "ALL",
      "companies": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "duplicateConsistencyToolTypes": [
        "DUPLICATE_POSTINGS"
      ]
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Duplicate Consistency Job - Create Or Update Bulk

HTTP Request

PUT /api/v1/sap-posting-bot/duplicate-consistency-check/jobs/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple jobs for the duplicate consistency check within the General Ledger, ensuring the integrity of ledger entries and financial records associated with transactions and accounts.

Parameters

Name	In	Type	Required	Description
body	body	DuplicateConsistencyJobDto	true	Request body containing bulk ledger entry data for creating or updating financial records, including transaction details and account information.

Body Parameters

[
  {
    "id": 0,
    "taskCount": 0,
    "failedTaskCount": 0,
    "doneTaskCount": 0,
    "inProgressTaskCount": 0,
    "cancelledTaskCount": 0,
    "errorMessage": "string",
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "executor": "SCHEDULER",
    "scheduleJobId": 0,
    "filter": {
      "fiscalYear": 0,
      "fiscalPeriod": 0,
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "companyFilterType": "ALL",
      "companies": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "duplicateConsistencyToolTypes": [
        "DUPLICATE_POSTINGS"
      ]
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListDuplicateConsistencyJobDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "taskCount": 0,
      "failedTaskCount": 0,
      "doneTaskCount": 0,
      "inProgressTaskCount": 0,
      "cancelledTaskCount": 0,
      "errorMessage": "string",
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "executor": "SCHEDULER",
      "scheduleJobId": 0,
      "filter": {
        "fiscalYear": 0,
        "fiscalPeriod": 0,
        "erpSystem": {
          "id": 0,
          "displayId": "string"
        },
        "companyFilterType": "ALL",
        "companies": [
          {
            "id": 0,
            "displayId": "string"
          }
        ],
        "duplicateConsistencyToolTypes": [
          "DUPLICATE_POSTINGS"
        ]
      }
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Duplicate Consistency Job - Bulk Update

HTTP Request

PUT /api/v1/sap-posting-bot/duplicate-consistency-check/jobs/bulk

Interactive Demo

📋 Description: Updates the status of multiple duplicate consistency check jobs for ledger entries, ensuring accurate transaction processing and maintaining the integrity of financial records within the General Ledger.

Parameters

Name	In	Type	Required	Description
body	body	DuplicateConsistencyJobDto	true	Request body containing a collection of ledger entry data for bulk duplication consistency checks, including transaction details, account identifiers, and associated financial records.

Body Parameters

[
  {
    "id": 0,
    "taskCount": 0,
    "failedTaskCount": 0,
    "doneTaskCount": 0,
    "inProgressTaskCount": 0,
    "cancelledTaskCount": 0,
    "errorMessage": "string",
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "executor": "SCHEDULER",
    "scheduleJobId": 0,
    "filter": {
      "fiscalYear": 0,
      "fiscalPeriod": 0,
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "companyFilterType": "ALL",
      "companies": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "duplicateConsistencyToolTypes": [
        "DUPLICATE_POSTINGS"
      ]
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListDuplicateConsistencyJobDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "taskCount": 0,
      "failedTaskCount": 0,
      "doneTaskCount": 0,
      "inProgressTaskCount": 0,
      "cancelledTaskCount": 0,
      "errorMessage": "string",
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "executor": "SCHEDULER",
      "scheduleJobId": 0,
      "filter": {
        "fiscalYear": 0,
        "fiscalPeriod": 0,
        "erpSystem": {
          "id": 0,
          "displayId": "string"
        },
        "companyFilterType": "ALL",
        "companies": [
          {
            "id": 0,
            "displayId": "string"
          }
        ],
        "duplicateConsistencyToolTypes": [
          "DUPLICATE_POSTINGS"
        ]
      }
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Duplicate Consistency Job - Find All

HTTP Request

GET /api/v1/sap-posting-bot/duplicate-consistency-check/jobs

Interactive Demo

📋 Description: Fetches a list of duplicate consistency check jobs related to ledger entries, transactions, and accounts within the General Ledger, enabling users to monitor and manage financial record integrity.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results of the duplicate consistency check for ledger entries and transactions should be returned in a paginated format, facilitating efficient data retrieval and management of financial records.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageDuplicateConsistencyJobDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "taskCount": 0,
      "failedTaskCount": 0,
      "doneTaskCount": 0,
      "inProgressTaskCount": 0,
      "cancelledTaskCount": 0,
      "errorMessage": "string",
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "executor": "SCHEDULER",
      "scheduleJobId": 0,
      "filter": {
        "fiscalYear": 0,
        "fiscalPeriod": 0,
        "erpSystem": {
          "id": 0,
          "displayId": "string"
        },
        "companyFilterType": "ALL",
        "companies": [
          {
            "id": 0,
            "displayId": "string"
          }
        ],
        "duplicateConsistencyToolTypes": [
          "DUPLICATE_POSTINGS"
        ]
      }
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Duplicate Consistency Job - Create

HTTP Request

POST /api/v1/sap-posting-bot/duplicate-consistency-check/jobs

Interactive Demo

📋 Description: Initiates a duplicate consistency check for ledger entries, ensuring the integrity of financial records by identifying potential duplicate transactions within specified accounts.

Parameters

Name	In	Type	Required	Description
body	body	DuplicateConsistencyJobDto	true	Request body containing the ledger entry details, including transaction identifiers and account information, necessary for conducting a duplicate consistency check on financial records.

Body Parameters

{
  "id": 0,
  "taskCount": 0,
  "failedTaskCount": 0,
  "doneTaskCount": 0,
  "inProgressTaskCount": 0,
  "cancelledTaskCount": 0,
  "errorMessage": "string",
  "erpSystem": {
    "id": 0,
    "displayId": "string"
  },
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z",
  "status": "CREATED",
  "executor": "SCHEDULER",
  "scheduleJobId": 0,
  "filter": {
    "fiscalYear": 0,
    "fiscalPeriod": 0,
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "companyFilterType": "ALL",
    "companies": [
      {
        "id": 0,
        "displayId": "string"
      }
    ],
    "duplicateConsistencyToolTypes": [
      "DUPLICATE_POSTINGS"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseDuplicateConsistencyJobDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "taskCount": 0,
    "failedTaskCount": 0,
    "doneTaskCount": 0,
    "inProgressTaskCount": 0,
    "cancelledTaskCount": 0,
    "errorMessage": "string",
    "erpSystem": {
      "id": 0,
      "displayId": "string"
    },
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "status": "CREATED",
    "executor": "SCHEDULER",
    "scheduleJobId": 0,
    "filter": {
      "fiscalYear": 0,
      "fiscalPeriod": 0,
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "companyFilterType": "ALL",
      "companies": [
        {
          "id": 0,
          "displayId": "string"
        }
      ],
      "duplicateConsistencyToolTypes": [
        "DUPLICATE_POSTINGS"
      ]
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Duplicate Consistency Job - Search

HTTP Request

POST /api/v1/sap-posting-bot/duplicate-consistency-check/jobs/search

Interactive Demo

📋 Description: Submits a request to initiate a duplicate consistency check for ledger entries, ensuring the accuracy and integrity of financial records associated with transactions and accounts.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	DuplicateConsistencyJobDtoFilter	false	Request body containing the parameters for searching duplicate consistency check jobs related to ledger entries, transactions, accounts, and financial records.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["createdAt,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "systemIdEqual": 0,
  "systemDisplayIdLike": "string",
  "statusEqual": "CREATED",
  "executorEqual": "SCHEDULER"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageDuplicateConsistencyJobDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "taskCount": 0,
      "failedTaskCount": 0,
      "doneTaskCount": 0,
      "inProgressTaskCount": 0,
      "cancelledTaskCount": 0,
      "errorMessage": "string",
      "erpSystem": {
        "id": 0,
        "displayId": "string"
      },
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "status": "CREATED",
      "executor": "SCHEDULER",
      "scheduleJobId": 0,
      "filter": {
        "fiscalYear": 0,
        "fiscalPeriod": 0,
        "erpSystem": {
          "id": 0,
          "displayId": "string"
        },
        "companyFilterType": "ALL",
        "companies": [
          {
            "id": 0,
            "displayId": "string"
          }
        ],
        "duplicateConsistencyToolTypes": [
          "DUPLICATE_POSTINGS"
        ]
      }
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Duplicate Consistency Job - List All Tool Type Options

HTTP Request

GET /api/v1/sap-posting-bot/duplicate-consistency-check/jobs/tool_type_options

Interactive Demo

📋 Description: Retrieves available tool type options for the duplicate consistency check process within the General Ledger, facilitating accurate ledger entry and transaction management. This operation supports users in ensuring the integrity of financial records and account transactions.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "DUPLICATE_POSTINGS"
]

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---