Thomson Reuters AP Batches API

Use the AP Batches AP Exchange API to view AP route batches and view and update batch runs.

GitHub OpenAPI
Business capability
Accounts Payable Management BC-200.20

Operations 3

GET /routes/{routeId}/batches Returns collection of AP route batches #
GET /routes/{routeId}/batches/{batchId}/runs Returns collection of AP route batch runs #
PATCH /routes/{routeId}/batches/{batchId} Updates batch run #

Documentation

📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/2A8320F8-60E8-2D73-A3F0-0D097B720566
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/2074AAC5-1C5E-2FF4-01D9-3B3E12470E4E
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/4A4ED3B6-3CF9-A7AA-9D0B-7B498E084A66
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/3A3301AC-8457-530C-A784-CE7EF7400372
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/AA887EC9-9ADD-9096-871D-5482B80A5B52
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/31e1b889-f210-4d5b-9bcf-635010703dc9
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/31888b43-b888-4dd6-a7b7-2e067dbf888e
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/a1deda95-6752-46bb-80c4-077adf399b0b
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/f2b3d8b9-9f8e-4a45-bc9e-3c2f5e1a7c72
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/B2230E9D-2AF1-4898-97B8-AE02DDD77148
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/a9d9b3ff-c347-5f6e-a57d-f909bdbfa6ad
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/50172ee5-942f-50ae-811b-375594ba9120
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/27cbc2df-7f6b-59a8-8a02-5a0fa786039b
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/0b5b2b78-4445-45db-9b05-f595f29446b8
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/ec8044b0-ec4f-4685-b534-87f61fef5f1e
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/DB6E2768-0A6D-3E20-9449-6514260A3966
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/6bfebc84-701d-55dc-9797-77cf9c114598
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/895e9465-00ee-49ae-9013-a7fe8f247571
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/5061bb88-6d4e-4dcc-93b7-39e5db653d0b
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/aa49b952-4489-4f7b-b3f3-b2b44e0d3c6a
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/2D4CEC0C-4E9C-6251-8BC6-6E4441583CA8
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/9f06ab86-77ad-5e5b-a242-4af9b5f10ac5
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/c262bb51-9e57-41a4-912c-cf297818c92f
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/232fbd10-f358-4e6b-84ac-cf92e8081301
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/fb510ade-9b86-443d-8114-3158b41b35b1
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/8C7B156C-86F8-4FBB-2D7C-FF08D226203C
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/a49d3dd1-a081-4a63-8ddf-b4c81d56a1bf
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/2bd8bc0a-2d03-4933-8f04-30354b9994ee
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/201e45ea-da0a-4c91-95ca-c325eedec76f
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/4733034A-2CCD-4969-9EE2-7295B5C28F7C
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/d923235a-2516-4d62-86d4-7b4d7a135842
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/2156ac58-d40e-40d7-851f-98824076d369
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/4f2a8b73-9d5c-6241-7e8f-3a9b5c2d8e6f
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/38d8017d-5e6b-468f-acb4-b2750cccd84f
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/07e5e4d3-ed2b-4c95-9eb3-90dea6240066
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/728f00b1-7e63-4688-b70f-b379981784d8
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/E22D603E-38AC-8B34-6B9E-29CA6DC187FC
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/5d1d0703-62d0-405b-b632-47e5c92cd240
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/5f8df477-2ccc-5df7-b2fb-1d8178dfe590
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/75EDA387-2BAB-8D73-90F5-2FE8FB135075
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/D96C7B0A-68C6-7686-65D4-29E08AA28780
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/56b4aa45-96f6-46ab-bf0a-de27fb559546
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/6F89580F-E782-488C-A61F-E9C5FBC273BA
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/2D93739A-83C0-67FE-426C-1C6E31E70631
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/7D9CEF42-113B-9A51-9C82-E6E74D19776C
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/e6716b6a-24e8-47ad-ab3a-57e638bf7cb9
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/6c16ad58-1136-40aa-aa4d-5d617372c7c9
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/237f8c17-bdda-58b0-a36f-32e84a63a6a4
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/ff81e7fa-08d9-4b71-9423-4aca5d06e530
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/160c07bb-df1b-5196-91a3-e4001d302c53
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/3e578529-098f-42ba-9eb7-8d15dfdb53e4
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/6dbf5008-bc7f-486c-ac4b-c65ecffe1c81
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/44b27e6b-80ce-5f3c-95c6-e8d533165adb
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/3E627370-5DCD-8F88-9E9B-B6108A1C5AED
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/332f4a37-ea21-4132-8647-853ca160461f
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/b2815363-79ba-578e-a664-b041dc3e9d3f
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/375d6c07-f451-498d-be53-c86eddcca5b2
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/381ec82b-75fa-54d5-8eee-71a5d01a375f
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/1f108418-f6cb-6a86-b152-41caea6fc703
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/934c3f83-264c-5885-9820-d8f0cc439b5a
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/80A8A0A0-33EC-0B1C-1D2E-7FF6662C55B5
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/095f583f-8c31-4ee6-ab20-e423c23e3e53
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/a318e5e1-5f8f-50a3-bb46-14e83e57d25f
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/04c760fa-1cfc-51cc-94a2-661f2d266acc
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/22172088-83f0-5c0a-b3fd-45a6f9c97a73
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/3b21c057-0c6e-4451-9434-f53f1acb9f5c
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/1f108418-f6cb-6a80-a6f0-597dec7cedfe
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/9a0f3363-a0bb-4a19-a70d-4433ebdc45b4
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/a4247340-69e0-48cf-b60e-832187e09b2e
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/f7e8d9c0-b1a2-4d3e-9f8a-7b6c5d4e3f2a
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/ee4e8cf1-99f1-49e1-8cf7-d9c1aff9ab88
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/66a86d95-5cca-49b6-a745-813bc4845cf2
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/3ABA57F3-D30D-4D32-87F6-A1FF30B23EED
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/cfbc0481-8a5c-4ac4-b157-b2e7a8f37768
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/f56b3c8a-dcd4-4b96-bb21-9023b33d807a
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/3085da2b-c667-45da-9822-f217b9c8b31a
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/eab11cf9-3f5b-5688-b50e-dc1fed5c402e
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/43F6AE83-8D57-343E-371A-013F9BE80FF0
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/cc1887b3-6d81-491d-9db4-ad4d68b48d09
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/789eb138-f254-4ce2-b777-01e3e99c2fd9
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/8bc674bf-d898-4639-9950-e6ee4483e99c
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/19F5E439-B724-4CB1-B71C-4A5BD7C765CB
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/1d6d579c-a4c7-539c-9515-e33c299df468
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/bbaf3eff-9dcc-4a1c-b1e8-83f1b52c069e
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/509FD0C3-8FAD-4DEA-6E47-D3AE37676051
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/390219f9-01b1-5008-b4cd-78ccb9b825ae
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/0caa6ecb-2358-45a5-aa51-1a5b5c3c965d
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/EDF6F25F-4B3C-4214-6917-238E70778115
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/f0ffe0b4-899e-455f-af3b-73e554cb5f10
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/78f906e2-d54f-530f-b3cf-99ee71043113
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/6CEB5AD8-579E-0914-09FB-B9DDA5E42CD7
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/93ABBBB6-57A8-23DC-8EC8-C894F1FD233F
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/2758BAF0-BC6D-4CEE-869B-021ECEF06816
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/d000d524-2886-4f1b-bcec-0fa9b73b3b97
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/8b4ccfbe-5c96-5db4-9c22-b63450f11dc8
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/b7010a0e-d010-5f41-ad0e-1cad5b0dc7c8
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/9f328e83-441c-4218-a48e-440cf99303cb
📖
Documentation
https://developers.thomsonreuters.com/pages/api-catalog/1f108418-f6cb-6a81-9e33-5d8e529696e2

Specifications

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/thomson-reuters/json-schema/thomson-reuters-trta-athena-models-api-v4-chart-of-accounts-chart-of-accounts-reponse-schema.json
📊
JSONSchema
https://artifacts.apis.io/thomson-reuters/json-schema/thomson-reuters-trta-athena-models-api-v4-chart-of-accounts-chart-of-accounts-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/thomson-reuters/json-schema/thomson-reuters-trta-athena-models-api-v4-chart-of-accounts-chart-of-accounts-put-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/thomson-reuters/json-schema/thomson-reuters-multi-status-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/thomson-reuters/json-schema/thomson-reuters-trta-athena-models-api-v4-queries-rollforward-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/thomson-reuters/json-schema/thomson-reuters-tracker-odata-response-of-apbatch-model-schema.json
📊
JSONSchema
https://artifacts.apis.io/thomson-reuters/json-schema/thomson-reuters-tracker-odata-response-of-apbatch-run-model-schema.json
📊
JSONSchema
https://artifacts.apis.io/thomson-reuters/json-schema/thomson-reuters-trta-athena-models-api-v4-reports-report-output-schema.json
📊
JSONSchema
https://artifacts.apis.io/thomson-reuters/json-schema/thomson-reuters-trta-athena-models-api-v4-reports-report-metadata-schema.json
📊
JSONSchema
https://artifacts.apis.io/thomson-reuters/json-schema/thomson-reuters-trta-athena-models-api-v4-reports-report-input-schema.json
📊
JSONSchema
https://artifacts.apis.io/thomson-reuters/json-schema/thomson-reuters-trta-athena-models-api-v4-reports-report-list-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/thomson-reuters/json-schema/thomson-reuters-trta-athena-models-api-v4-common-opertaions-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/thomson-reuters/json-schema/thomson-reuters-company-info-collection-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/thomson-reuters:thomson-reuters-ap-batches-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

thomson-reuters-ap-batches-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Thomson Reuters AP Batches API
  version: '1.0'
  description: 'Operations tagged AP Batches across 2 of this provider''s published API definitions: thomson-reuters-ap-exchange-api-1-0-openapi.json, thomson-reuters-ap-exchange-api-1-0-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.thomsonreuters.com/legal-tracker/ap-exchange-api/v1
- url: https://api.thomsonreuters.co.uk/legal-tracker/ap-exchange-api/v1
- url: https://api.thomsonreuters.ca/legal-tracker/ap-exchange-api/v1
- url: https://api.thomsonreuters.com.au/legal-tracker/ap-exchange-api/v1
- url: https://api.thomsonreuters.de/legal-tracker/ap-exchange-api/v1
- url: https://api.thomsonreuters.ae/legal-tracker/ap-exchange-api/v1
tags:
- name: AP Batches
  description: Use the AP Batches AP Exchange API to view AP route batches and view and update batch runs.
paths:
  /routes/{routeId}/batches:
    get:
      tags:
      - AP Batches
      summary: Returns collection of AP route batches
      operationId: APBatch_Index
      parameters:
      - name: routeId
        in: path
        required: true
        description: ID of AP route (Sequence Number)
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: $filter
        in: query
        description: 'Filter batches (example: batchRunDateTime gt 2020-11-26T15:59:12.000Z)'
        schema:
          type: string
      - name: $select
        in: query
        description: Select fields defined in request
        schema:
          type: string
      - name: $count
        in: query
        description: Include parameter with count of items
        schema:
          type: boolean
      - name: $top
        in: query
        description: Limit quantity of items
        schema:
          type: integer
      - name: $skip
        in: query
        description: Skip quantity of items
        schema:
          type: integer
      responses:
        '200':
          description: TrackerODataResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackerODataResponseOfAPBatchModel'
        '400':
          description: One or more validation errors in the request were encountered while processing the initial request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The requested resource requires authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Access is denied:
                  value:
                    error:
                      code: Unauthorized
                      message: The requested resource requires authentication.
        '403':
          description: The web service account has insufficient permissions to access this endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No request with that identifier could be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - OAuth2: []
      - Token: []
    servers:
    - url: https://api.thomsonreuters.com/legal-tracker/ap-exchange-api/v1
    - url: https://api.thomsonreuters.co.uk/legal-tracker/ap-exchange-api/v1
    - url: https://api.thomsonreuters.ca/legal-tracker/ap-exchange-api/v1
    - url: https://api.thomsonreuters.com.au/legal-tracker/ap-exchange-api/v1
    - url: https://api.thomsonreuters.de/legal-tracker/ap-exchange-api/v1
    - url: https://api.thomsonreuters.ae/legal-tracker/ap-exchange-api/v1
  /routes/{routeId}/batches/{batchId}/runs:
    get:
      tags:
      - AP Batches
      summary: Returns collection of AP route batch runs
      operationId: APBatch_GetBatchRuns
      parameters:
      - name: routeId
        in: path
        required: true
        description: ID of AP route (Sequence Number)
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: batchId
        in: path
        required: true
        description: AP batch ID
        schema:
          type:
          - string
          - 'null'
        x-position: 2
      - name: $filter
        in: query
        description: 'Filter batch runs (example: sentToAPDateTime gt 2020-11-26T15:59:12.000Z)'
        schema:
          type: string
      - name: $select
        in: query
        description: Select fields defined in request
        schema:
          type: string
      - name: $count
        in: query
        description: Include parameter with count of items
        schema:
          type: boolean
      - name: $top
        in: query
        description: Limit quantity of items
        schema:
          type: integer
      - name: $skip
        in: query
        description: Skip quantity of items
        schema:
          type: integer
      responses:
        '200':
          description: TrackerODataResponse
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackerODataResponseOfAPBatchRunModel'
        '400':
          description: One or more validation errors in the request were encountered while processing the initial request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The requested resource requires authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Access is denied:
                  value:
                    error:
                      code: Unauthorized
                      message: The requested resource requires authentication.
        '403':
          description: The web service account has insufficient permissions to access this endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No request with that identifier could be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - OAuth2: []
      - Token: []
    servers:
    - url: https://api.thomsonreuters.com/legal-tracker/ap-exchange-api/v1
    - url: https://api.thomsonreuters.co.uk/legal-tracker/ap-exchange-api/v1
    - url: https://api.thomsonreuters.ca/legal-tracker/ap-exchange-api/v1
    - url: https://api.thomsonreuters.com.au/legal-tracker/ap-exchange-api/v1
    - url: https://api.thomsonreuters.de/legal-tracker/ap-exchange-api/v1
    - url: https://api.thomsonreuters.ae/legal-tracker/ap-exchange-api/v1
  /routes/{routeId}/batches/{batchId}:
    patch:
      tags:
      - AP Batches
      summary: Updates batch run
      operationId: APBatch_Patch
      parameters:
      - name: routeId
        in: path
        required: true
        description: AP route ID (Sequence Number)
        schema:
          type: integer
          format: int32
        x-position: 1
      - name: batchId
        in: path
        required: true
        description: AP batch ID
        schema:
          type:
          - string
          - 'null'
        x-position: 2
      - name: Prefer
        in: header
        description: '* return=representation: This is the default. The server includes an entity representing the current state of the resource. In response to a successful request a status of 200 would be returned.

          * return=minimal: The response will not include the entity in the response. A successful request would result in a status of 204 to be returned.

          '
        schema:
          type: string
          example: return=representation
      requestBody:
        x-name: apBatchModel
        description: AP batch to update
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/APBatchPaymentModel'
        x-position: 3
      responses:
        '200':
          description: APBatchModel
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APBatchModel'
        '204':
          description: Record was patched successfully
        '400':
          description: One or more validation errors in the request were encountered while processing the initial request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The requested resource requires authentication.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Access is denied:
                  value:
                    error:
                      code: Unauthorized
                      message: The requested resource requires authentication.
        '403':
          description: The web service account has insufficient permissions to access this endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No request with that identifier could be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - OAuth2: []
      - Token: []
    servers:
    - url: https://api.thomsonreuters.com/legal-tracker/ap-exchange-api/v1
    - url: https://api.thomsonreuters.co.uk/legal-tracker/ap-exchange-api/v1
    - url: https://api.thomsonreuters.ca/legal-tracker/ap-exchange-api/v1
    - url: https://api.thomsonreuters.com.au/legal-tracker/ap-exchange-api/v1
    - url: https://api.thomsonreuters.de/legal-tracker/ap-exchange-api/v1
    - url: https://api.thomsonreuters.ae/legal-tracker/ap-exchange-api/v1
components:
  schemas:
    ErrorResponse:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
            message:
              type: string
            target:
              type: string
            details:
              type: array
              items:
                type: object
                required:
                - code
                - message
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  target:
                    type: string
            innererror:
              type: object
              description: The structure of this object is service-specific.
    APBatchModel:
      title: APBatchModel
      type: object
      additionalProperties: false
      properties:
        batchId:
          type: string
        apRouteId:
          type: integer
          format: int32
        sentToAPDateTime:
          type: string
          format: date-time
        batchRunDateTime:
          type: string
          format: date-time
        paymentStatus:
          $ref: '#/components/schemas/APExtractAllowedBatchPaymentStatuses'
        paymentComments:
          type:
          - string
          - 'null'
    TrackerODataResponseOfAPBatchModel:
      type: object
      properties:
        count:
          type: integer
        value:
          type: array
          items:
            title: APBatchModel
            type: object
            additionalProperties: false
            properties:
              batchId:
                type: string
              apRouteId:
                type: integer
                format: int32
              sentToAPDateTime:
                type: string
                format: date-time
              batchRunDateTime:
                type: string
                format: date-time
              paymentStatus:
                $ref: '#/components/schemas/APExtractAllowedBatchPaymentStatuses'
              paymentComments:
                type:
                - string
                - 'null'
        nextLink:
          type: string
    TAPExtractAllowedBatchPaymentStatuses:
      type: string
      description: ''
      x-enumFlags: true
      x-enumNames:
      - None
      - APPaymentInProcess
      - ContentError
      - OnHold
      - WillNotBePaid
      - Other
      - Submitted
      - Resubmitted
      - Paid
      enum:
      - None
      - APPaymentInProcess
      - ContentError
      - OnHold
      - WillNotBePaid
      - Other
      - Submitted
      - Resubmitted
      - Paid
    APBatchPaymentModel:
      type: object
      additionalProperties: false
      properties:
        paymentStatus:
          $ref: '#/components/schemas/TAPExtractAllowedBatchPaymentStatuses'
        paymentComments:
          type:
          - string
          - 'null'
          maxLength: 250
          minLength: 0
    TrackerODataResponseOfAPBatchRunModel:
      type: object
      properties:
        count:
          type: integer
        value:
          type: array
          items:
            title: APBatchRunModel
            type: object
            additionalProperties: false
            properties:
              id:
                type:
                - string
                - 'null'
              batchId:
                type:
                - string
                - 'null'
              apRouteId:
                type: integer
                format: int32
              sentToAPDateTime:
                type: string
                format: date-time
              runDateTime:
                type: string
                format: date-time
              invoiceCount:
                type: integer
                format: int32
        nextLink:
          type: string
    APExtractAllowedBatchPaymentStatuses:
      type: string
      description: ''
      x-enumFlags: true
      x-enumNames:
      - None
      - APPaymentInProcess
      - ContentError
      - OnHold
      - WillNotBePaid
      - Other
      - Submitted
      - Resubmitted
      - Paid
      enum:
      - None
      - APPaymentInProcess
      - ContentError
      - OnHold
      - WillNotBePaid
      - Other
      - Submitted
      - Resubmitted
      - Paid
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.thomsonreuters.com/onepass/oauth2/token?grant_type=client_credentials
          scopes:
            access: Grants access to Tracker APIs
    Token:
      type: http
      description: Access token (TR Account)
      scheme: bearer
x-refined-from:
- thomson-reuters-ap-exchange-api-1-0-openapi.json
- thomson-reuters-ap-exchange-api-1-0-openapi.yml
x-generator: NSwag v13.18.2.0 (NJsonSchema v10.8.0.0 (Newtonsoft.Json v13.0.0.0))
x-provenance:
  method: harvested
  publisher: Thomson Reuters
  source: https://api.thomsonreuters.com/developer-experience/content/v1/documents/api-reference/3ba61efb-acae-4b0d-8dff-ecca307d08cf
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)