Merge

Merge subpackage_payments API

The subpackage_payments API from Merge — 6 operation(s) for subpackage_payments.

Documentation GitHub OpenAPI

Operations 8

GET /accounting/v1/payments List #

POST /accounting/v1/payments Create #

GET /accounting/v1/payments/{id} Retrieve #

PATCH /accounting/v1/payments/{id} Partial Update #

GET /accounting/v1/payments/line-items/remote-field-classes Line Items Remote Field Classes List #

GET /accounting/v1/payments/meta/patch/{id} Meta Patch Retrieve #

GET /accounting/v1/payments/meta/post Meta Post Retrieve #

GET /accounting/v1/payments/remote-field-classes Remote Field Classes List #

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/merge-subpackage-payments-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Accounting Subpackage Payments API
  version: 1.0.0
servers:
- url: https://api.merge.dev/api
- url: https://api-eu.merge.dev/api
- url: https://api-ap.merge.dev/api
tags:
- name: subpackage_payments
paths:
  /accounting/v1/payments:
    get:
      operationId: list
      summary: List
      description: Returns a list of `Payment` objects.{/* BEGIN_ACCOUNTING_PAYMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+1Ya2/iOBT9K8gfEZBpGaiKtFrx6pTuEDotHbU7qqyLcwmGxE5thxZG899XDqFA353NMmh3vxE/zo3vOT73ku+EgUFfqhmpEWBMxsJw4ZMCCaWHAamRU5iFKAwpEIi4CyFuLKTTfVIgOo4iqQx6RxwDTx8rHJIacUJUPhZjwYccPWe1yeHCoK/AcCm0c7+5OEx2kwIJuJigV19seB1usbyYjjx41E7AtX39CLQ2IyVjf3SGNzHqNyDbdwvQnh+CogcGnDWUolrAPDVmT+FhgAa9FhhooUFmj5tGHBkT6ZrjjDCISkn0kodTB4UDynAWoHYq5cP9g8NKMUVJov9O/eC3vfz4ZiAHB3nqs4BCnO/22Z3b79y6Y/+j2/x4584vKu58MnfHkw956kO+2+9Wev2rcq9V3+s9sYCeVy8PvzZajRM3z+btsju+unX7bK/bZ5PBvFM++cRuT46/3Lnzq/1u66Ls9tuVk09yr9c8093mmezWSyVSIOusktq37+sDqXCOFOpRQ8qJzc/adCcEH9fysiAEIl6M4kHAWUmXSxDCXAq41SUmQydEj4OzwqPnNzEopJ+lL0vjyCo4yRyX4j75pEba7nHdbbZbm3qoT4EHMAiQ1IyK8ZGgSe0bYVIYYFZITKHHDRXSoH2KlULBZsmBppIzO6gwlAap5WzziUZgRqsh7q1+x5EHBj0KNoaRBgIKoRWifVQgNCSHsDBIru22m5gr9E5BQYgGlX3N6x+Fp/Le5UxJLYcm15oJCDnTuXK1kmvEmgvUOtdEYRQE2ZByH4wug9FytUKXwWgajDZlIBU9vGsfVasHpUhkz1nqXZ+5wI7BsARRFHCb4mVeHy5YMfhwJlqzwQWIkTSwB7IakGEEwkpgpZL3M8wm1lBTP+YJ8CPeC8TMovfTLwXOBlx52RB8GoAZShXew/4j5KU2vJHU3b1hLprzmCcMZZBhF422aFQnrvZCft16v/O1vYWrsel6b784YxkrAQG1l3728sW6J3ytv4hQcem9/dqt2THesREIH6la3Jyko6FxnEgiDUtDNKME/12C2ubl7SlgAeaOYs2lyDUDGXu59tlpNkJbgNMFOE3AafvslBbTerobtrxckGbxZ1z74cwm3S/MLul/Zgl/VpvbVeSvLjFfYs4mSSeW6wmbhGz0uYItLqyQXgz3q42DvV2wxFdkuVXH/F+B5+DjWkeb+GR9/R9tBnK0MWijWV/+2/hjejktn4+31v+84CW72xolxHTsEdIeLhsaUsQlFdMpd/UB/It94dVitqhFL3vCuzqmbZSkLIrPJSqZjbIsUlpp/hNKemsFee6Txy90oZ+Typ9yJHMZfoGyeI8/QO1E18z/Pv/vcotd4v76x1/7+9OZ2hYAAA==" /></Footer>{/* END_ACCOUNTING_PAYMENT_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_payments
      parameters:
      - name: account_id
        in: query
        description: If provided, will only return payments for this account.
        required: false
        schema:
          type: string
      - name: company_id
        in: query
        description: If provided, will only return payments for this company.
        required: false
        schema:
          type: string
      - name: contact_id
        in: query
        description: If provided, will only return payments for this contact.
        required: false
        schema:
          type: string
      - name: created_after
        in: query
        description: If provided, will only return objects created after this datetime.
        required: false
        schema:
          type: string
          format: date-time
      - name: created_before
        in: query
        description: If provided, will only return objects created before this datetime.
        required: false
        schema:
          type: string
          format: date-time
      - name: cursor
        in: query
        description: The pagination cursor value.
        required: false
        schema:
          type: string
      - name: expand
        in: query
        description: Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/PaymentsGetParametersExpandSchemaItems'
      - name: include_deleted_data
        in: query
        description: Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
        required: false
        schema:
          type: boolean
      - name: include_remote_data
        in: query
        description: Whether to include the original data Merge fetched from the third-party to produce these models.
        required: false
        schema:
          type: boolean
      - name: include_remote_fields
        in: query
        description: Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
        required: false
        schema:
          type: boolean
      - name: include_shell_data
        in: query
        description: Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
        required: false
        schema:
          type: boolean
      - name: modified_after
        in: query
        description: If provided, only objects synced by Merge after this date time will be returned.
        required: false
        schema:
          type: string
          format: date-time
      - name: modified_before
        in: query
        description: If provided, only objects synced by Merge before this date time will be returned.
        required: false
        schema:
          type: string
          format: date-time
      - name: page_size
        in: query
        description: Number of results to return per page. The maximum limit is 100.
        required: false
        schema:
          type: integer
      - name: remote_id
        in: query
        description: The API provider's ID for the given object.
        required: false
        schema:
          type: string
      - name: transaction_date_after
        in: query
        description: If provided, will only return objects created after this datetime.
        required: false
        schema:
          type: string
          format: date-time
      - name: transaction_date_before
        in: query
        description: If provided, will only return objects created before this datetime.
        required: false
        schema:
          type: string
          format: date-time
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedPaymentList'
    post:
      operationId: create
      summary: Create
      description: Creates a `Payment` object with the given values.{/* BEGIN_ACCOUNTING_PAYMENT_CREATE_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="POST" data="H4sIAAAAAAAAA92Wb2/aOhTGv0rllygko4xVRbq6ooWtVJewtXRa71RZB+c0GBw7tR1amPrdJydpgS2oay/7o/vS5vg5x+f88uAvhIHFWOkFaRNgTGXSchkTjyQqQkHa5D0sEpSWeARSHkKCG4F0vk88YrI0Vdpi9JajiMyJxmvSJkGCOsZ6Jvk1xyhYHQq4tBhrsFxJEzwerl/np4lHBJczjDrFgaflivB6ufPN0gSCG1d+CsbYiVZZPDnDmwzNDyi72gS6+4OoR2AhWFOp60Kmas/dIkKBFqMuWOiiReauW2acWJuadhBMUKR+nt2PcB6gDEBbzgSaoNU83D84bNVLlTz73zQWfzVq05uxGh/UaMwEhaw2GLG7cNS/Dafx6/D49V24vGiFy9kynM5e1WgMtcFo0BqOLpvDbqcxrAig528+HX486h6dhjW27DXD6eVtOGKNwYjNxst+8/Qduz09+XAXLi/3B92LZjjqtU7fqcbw+MwMjs/UoOP7xCPrUyXtz1/WN0pw3mo0kyOlZq4/az/3E4hxrS/FQCDl9TQbC8580/QhgaWScGt8ppIgwYhDsNKj5zcZaKT/qFj509QRnHeOK/nYfNImvfCkEx73ups8dObABYwFkrbVGX4HNGl/JkwlKcgF8QhT0gJzSLFMa5TMbXI5V5wh8YjGRFmkPCIescqCoJA4ntxSgzSQ10IjsC7aLlIkV+7UTcY1Ru9BQ4IWdZ4U0lRwjKhVVHCJxi/Fiy9lY0WZAOPauip0rcE0dbrGL9mm60VWhJW32Qh7MvXVvVc18xDtecbzy+5g4iFa49Soyeftp3LbqMPOqP+x9/xBly1yhreyuRQ1V64L305ko+GVZOAdm4CMkepi4itScoulWZa3Ny18liZoJ3mmit5nqaMmomAr2WIzV2pp6Dyv7b8T97DxmKiCSZFXpcZTZLYo+KmgvAjvhXw/NPmlRH7IOJvlrrE3lC7vbtBcydYLOOnF9f6bo4PGz4W0CshnYThVmZYgKEqrF7shcZO57bBtvcWOQfiBGqtROYcY9/ouT55oB5Q4RVoqPvxpzec8NAfw6zl5lnH9CVxUofI/dKhPqNVucHNKpR39RhvSGHFLpco52u5EvwCoF/rAv2qi9nb4cHV6379btw/o5e/WXTqA/mOets/z/ryQ+6v7r9vVI8nuDgAA" /></Footer>{/* END_ACCOUNTING_PAYMENT_CREATE_SUPPORTED_FIELDS */}
      tags:
      - subpackage_payments
      parameters:
      - name: is_debug_mode
        in: query
        description: Whether to include debug fields (such as log file links) in the response.
        required: false
        schema:
          type: boolean
      - name: run_async
        in: query
        description: Whether or not third-party updates should be run asynchronously.
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentEndpointRequest'
  /accounting/v1/payments/{id}:
    get:
      operationId: retrieve
      summary: Retrieve
      description: Returns a `Payment` object with the given `id`.{/* BEGIN_ACCOUNTING_PAYMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+1Ya2/iOBT9K8gfEZBpGaiKtFrx6pTuEDotHbU7qqyLcwmGxE5thxZG899XDqFA353NMmh3vxE/zo3vOT73ku+EgUFfqhmpEWBMxsJw4ZMCCaWHAamRU5iFKAwpEIi4CyFuLKTTfVIgOo4iqQx6RxwDTx8rHJIacUJUPhZjwYccPWe1yeHCoK/AcCm0c7+5OEx2kwIJuJigV19seB1usbyYjjx41E7AtX39CLQ2IyVjf3SGNzHqNyDbdwvQnh+CogcGnDWUolrAPDVmT+FhgAa9FhhooUFmj5tGHBkT6ZrjjDCISkn0kodTB4UDynAWoHYq5cP9g8NKMUVJov9O/eC3vfz4ZiAHB3nqs4BCnO/22Z3b79y6Y/+j2/x4584vKu58MnfHkw956kO+2+9Wev2rcq9V3+s9sYCeVy8PvzZajRM3z+btsju+unX7bK/bZ5PBvFM++cRuT46/3Lnzq/1u66Ls9tuVk09yr9c8093mmezWSyVSIOusktq37+sDqXCOFOpRQ8qJzc/adCcEH9fysiAEIl6M4kHAWUmXSxDCXAq41SUmQydEj4OzwqPnNzEopJ+lL0vjyCo4yRyX4j75pEba7nHdbbZbm3qoT4EHMAiQ1IyK8ZGgSe0bYVIYYFZITKHHDRXSoH2KlULBZsmBppIzO6gwlAap5WzziUZgRqsh7q1+x5EHBj0KNoaRBgIKoRWifVQgNCSHsDBIru22m5gr9E5BQYgGlX3N6x+Fp/Le5UxJLYcm15oJCDnTuXK1kmvEmgvUOtdEYRQE2ZByH4wug9FytUKXwWgajDZlIBU9vGsfVasHpUhkz1nqXZ+5wI7BsARRFHCb4mVeHy5YMfhwJlqzwQWIkTSwB7IakGEEwkpgpZL3M8wm1lBTP+YJ8CPeC8TMovfTLwXOBlx52RB8GoAZShXew/4j5KU2vJHU3b1hLprzmCcMZZBhF422aFQnrvZCft16v/O1vYWrsel6b784YxkrAQG1l3728sW6J3ytv4hQcem9/dqt2THesREIH6la3Jyko6FxnEgiDUtDNKME/12C2ubl7SlgAeaOYs2lyDUDGXu59tlpNkJbgNMFOE3AafvslBbTerobtrxckGbxZ1z74cwm3S/MLul/Zgl/VpvbVeSvLjFfYs4mSSeW6wmbhGz0uYItLqyQXgz3q42DvV2wxFdkuVXH/F+B5+DjWkeb+GR9/R9tBnK0MWijWV/+2/hjejktn4+31v+84CW72xolxHTsEdIeLhsaUsQlFdMpd/UB/It94dVitqhFL3vCuzqmbZSkLIrPJSqZjbIsUlpp/hNKemsFee6Txy90oZ+Typ9yJHMZfoGyeI8/QO1E18z/Pv/vcotd4v76x1/7+9OZ2hYAAA==" /></Footer>{/* END_ACCOUNTING_PAYMENT_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_payments
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: expand
        in: query
        description: Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
        required: false
        schema:
          type: array
          items:
            $ref: '#/components/schemas/PaymentsIdGetParametersExpandSchemaItems'
      - name: include_remote_data
        in: query
        description: Whether to include the original data Merge fetched from the third-party to produce these models.
        required: false
        schema:
          type: boolean
      - name: include_remote_fields
        in: query
        description: Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.
        required: false
        schema:
          type: boolean
      - name: include_shell_data
        in: query
        description: Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
    patch:
      operationId: partial-update
      summary: Partial Update
      description: Updates a `Payment` object with the given `id`.{/* BEGIN_ACCOUNTING_PAYMENT_EDIT_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="PATCH" data="H4sIAAAAAAAAA7WUa08iMRSG/8qmHwnMLCBrJNlsuKmQpXhBs8aY5tA5DIVOO7YdFYz/fdOBCChGTfRbe+Zc3+dMHwkHh7E2c1InwLnOlBMqJkWS6AglqZMTmCeoHCkSSAWFBLcc2V2FFInN0lQbh9GhQBnZY4NjUidhgibGUqbEWGAUroNCoRzGBpzQyobPwaVxHk2KRAo1w6ixDHg/3dK9tLK8uNpQCuvbT8FaNzE6iydneJuh/UBm35tEPz/IUgQOwo0sJbNMs8vmp4hQosOoDQ7a6JD7cVcVJ86lth6GE5RpkFcPIrwLUYVgnOASbVirHlT2D2qlVZa8+h8Wy9/lwvR2pEf7BRZzySAr9If8gQ6793Qa79HW3gNdXNToYrag09nPAouh0B/2a4PhVXXQbpQHOxzY+a9/B5fNdrNHC3zRqdLp1T0d8nJ/yGejRbfaO+L3vePTB7q4qvTbF1U67NR6R7o8aJ3ZfutM9xtBQIpkkyqpXz9uGlaLc2jQTppaz7w+G5+7CcS4ocsSCKSilGYjKXhgqwEksNAK7m3AdRImGAkI1/nY+W0GBtlfHetgmvoNzpUTWj2LT+qkQ48btNVpb+9D4w6EhJFEUncmw1cLTerXhOskBTUnRcIzY1BxfzSYaIdMROtzlkbgMGLgd85pB5JB4vfJXw0oC3kvzHt50zxFcuOjbzNhMDoBAwk6NHlRSFMpMGJOMykU2mBVZPmnbN0Yl2C9rOtG33W+eSruokTRnWcib+8LGFF01mdjNicUpOotOLQx7F52Po9m9cP6J2r9MKVohPZcXmq4JRHXygF321TxgU9AxcjMktHnKfOZb2H1tIq85iv2b0F/A8ppJvgsX/UfA+UH+Ro667SlJR92Ma78au6Xv5fTLibfQuKjmt88/QdwwziWCwcAAA==" /></Footer>{/* END_ACCOUNTING_PAYMENT_EDIT_SUPPORTED_FIELDS */}
      tags:
      - subpackage_payments
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: is_debug_mode
        in: query
        description: Whether to include debug fields (such as log file links) in the response.
        required: false
        schema:
          type: boolean
      - name: run_async
        in: query
        description: Whether or not third-party updates should be run asynchronously.
        required: false
        schema:
          type: boolean
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedPaymentEndpointRequest'
  /accounting/v1/payments/line-items/remote-field-classes:
    get:
      operationId: line-items-remote-field-classes-list
      summary: Line Items Remote Field Classes List
      description: Returns a list of `RemoteFieldClass` objects.{/* BEGIN_ACCOUNTING_PAYMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+1Ya2/iOBT9K8gfEZBpGaiKtFrx6pTuEDotHbU7qqyLcwmGxE5thxZG899XDqFA353NMmh3vxE/zo3vOT73ku+EgUFfqhmpEWBMxsJw4ZMCCaWHAamRU5iFKAwpEIi4CyFuLKTTfVIgOo4iqQx6RxwDTx8rHJIacUJUPhZjwYccPWe1yeHCoK/AcCm0c7+5OEx2kwIJuJigV19seB1usbyYjjx41E7AtX39CLQ2IyVjf3SGNzHqNyDbdwvQnh+CogcGnDWUolrAPDVmT+FhgAa9FhhooUFmj5tGHBkT6ZrjjDCISkn0kodTB4UDynAWoHYq5cP9g8NKMUVJov9O/eC3vfz4ZiAHB3nqs4BCnO/22Z3b79y6Y/+j2/x4584vKu58MnfHkw956kO+2+9Wev2rcq9V3+s9sYCeVy8PvzZajRM3z+btsju+unX7bK/bZ5PBvFM++cRuT46/3Lnzq/1u66Ls9tuVk09yr9c8093mmezWSyVSIOusktq37+sDqXCOFOpRQ8qJzc/adCcEH9fysiAEIl6M4kHAWUmXSxDCXAq41SUmQydEj4OzwqPnNzEopJ+lL0vjyCo4yRyX4j75pEba7nHdbbZbm3qoT4EHMAiQ1IyK8ZGgSe0bYVIYYFZITKHHDRXSoH2KlULBZsmBppIzO6gwlAap5WzziUZgRqsh7q1+x5EHBj0KNoaRBgIKoRWifVQgNCSHsDBIru22m5gr9E5BQYgGlX3N6x+Fp/Le5UxJLYcm15oJCDnTuXK1kmvEmgvUOtdEYRQE2ZByH4wug9FytUKXwWgajDZlIBU9vGsfVasHpUhkz1nqXZ+5wI7BsARRFHCb4mVeHy5YMfhwJlqzwQWIkTSwB7IakGEEwkpgpZL3M8wm1lBTP+YJ8CPeC8TMovfTLwXOBlx52RB8GoAZShXew/4j5KU2vJHU3b1hLprzmCcMZZBhF422aFQnrvZCft16v/O1vYWrsel6b784YxkrAQG1l3728sW6J3ytv4hQcem9/dqt2THesREIH6la3Jyko6FxnEgiDUtDNKME/12C2ubl7SlgAeaOYs2lyDUDGXu59tlpNkJbgNMFOE3AafvslBbTerobtrxckGbxZ1z74cwm3S/MLul/Zgl/VpvbVeSvLjFfYs4mSSeW6wmbhGz0uYItLqyQXgz3q42DvV2wxFdkuVXH/F+B5+DjWkeb+GR9/R9tBnK0MWijWV/+2/hjejktn4+31v+84CW72xolxHTsEdIeLhsaUsQlFdMpd/UB/It94dVitqhFL3vCuzqmbZSkLIrPJSqZjbIsUlpp/hNKemsFee6Txy90oZ+Typ9yJHMZfoGyeI8/QO1E18z/Pv/vcotd4v76x1/7+9OZ2hYAAA==" /></Footer>{/* END_ACCOUNTING_PAYMENT_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_payments
      parameters:
      - name: cursor
        in: query
        description: The pagination cursor value.
        required: false
        schema:
          type: string
      - name: include_deleted_data
        in: query
        description: Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
        required: false
        schema:
          type: boolean
      - name: include_remote_data
        in: query
        description: Whether to include the original data Merge fetched from the third-party to produce these models.
        required: false
        schema:
          type: boolean
      - name: include_shell_data
        in: query
        description: Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
        required: false
        schema:
          type: boolean
      - name: is_common_model_field
        in: query
        description: If provided, will only return remote field classes with this is_common_model_field value
        required: false
        schema:
          type: boolean
      - name: is_custom
        in: query
        description: If provided, will only return remote fields classes with this is_custom value
        required: false
        schema:
          type: boolean
      - name: page_size
        in: query
        description: Number of results to return per page. The maximum limit is 100.
        required: false
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRemoteFieldClassList'
  /accounting/v1/payments/meta/patch/{id}:
    get:
      operationId: meta-patch-retrieve
      summary: Meta Patch Retrieve
      description: Returns metadata for `Payment` PATCHs.{/* BEGIN_ACCOUNTING_PAYMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+1Ya2/iOBT9K8gfEZBpGaiKtFrx6pTuEDotHbU7qqyLcwmGxE5thxZG899XDqFA353NMmh3vxE/zo3vOT73ku+EgUFfqhmpEWBMxsJw4ZMCCaWHAamRU5iFKAwpEIi4CyFuLKTTfVIgOo4iqQx6RxwDTx8rHJIacUJUPhZjwYccPWe1yeHCoK/AcCm0c7+5OEx2kwIJuJigV19seB1usbyYjjx41E7AtX39CLQ2IyVjf3SGNzHqNyDbdwvQnh+CogcGnDWUolrAPDVmT+FhgAa9FhhooUFmj5tGHBkT6ZrjjDCISkn0kodTB4UDynAWoHYq5cP9g8NKMUVJov9O/eC3vfz4ZiAHB3nqs4BCnO/22Z3b79y6Y/+j2/x4584vKu58MnfHkw956kO+2+9Wev2rcq9V3+s9sYCeVy8PvzZajRM3z+btsju+unX7bK/bZ5PBvFM++cRuT46/3Lnzq/1u66Ls9tuVk09yr9c8093mmezWSyVSIOusktq37+sDqXCOFOpRQ8qJzc/adCcEH9fysiAEIl6M4kHAWUmXSxDCXAq41SUmQydEj4OzwqPnNzEopJ+lL0vjyCo4yRyX4j75pEba7nHdbbZbm3qoT4EHMAiQ1IyK8ZGgSe0bYVIYYFZITKHHDRXSoH2KlULBZsmBppIzO6gwlAap5WzziUZgRqsh7q1+x5EHBj0KNoaRBgIKoRWifVQgNCSHsDBIru22m5gr9E5BQYgGlX3N6x+Fp/Le5UxJLYcm15oJCDnTuXK1kmvEmgvUOtdEYRQE2ZByH4wug9FytUKXwWgajDZlIBU9vGsfVasHpUhkz1nqXZ+5wI7BsARRFHCb4mVeHy5YMfhwJlqzwQWIkTSwB7IakGEEwkpgpZL3M8wm1lBTP+YJ8CPeC8TMovfTLwXOBlx52RB8GoAZShXew/4j5KU2vJHU3b1hLprzmCcMZZBhF422aFQnrvZCft16v/O1vYWrsel6b784YxkrAQG1l3728sW6J3ytv4hQcem9/dqt2THesREIH6la3Jyko6FxnEgiDUtDNKME/12C2ubl7SlgAeaOYs2lyDUDGXu59tlpNkJbgNMFOE3AafvslBbTerobtrxckGbxZ1z74cwm3S/MLul/Zgl/VpvbVeSvLjFfYs4mSSeW6wmbhGz0uYItLqyQXgz3q42DvV2wxFdkuVXH/F+B5+DjWkeb+GR9/R9tBnK0MWijWV/+2/hjejktn4+31v+84CW72xolxHTsEdIeLhsaUsQlFdMpd/UB/It94dVitqhFL3vCuzqmbZSkLIrPJSqZjbIsUlpp/hNKemsFee6Txy90oZ+Typ9yJHMZfoGyeI8/QO1E18z/Pv/vcotd4v76x1/7+9OZ2hYAAA==" /></Footer>{/* END_ACCOUNTING_PAYMENT_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_payments
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaResponse'
  /accounting/v1/payments/meta/post:
    get:
      operationId: meta-post-retrieve
      summary: Meta Post Retrieve
      description: Returns metadata for `Payment` POSTs.{/* BEGIN_ACCOUNTING_PAYMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+1Ya2/iOBT9K8gfEZBpGaiKtFrx6pTuEDotHbU7qqyLcwmGxE5thxZG899XDqFA353NMmh3vxE/zo3vOT73ku+EgUFfqhmpEWBMxsJw4ZMCCaWHAamRU5iFKAwpEIi4CyFuLKTTfVIgOo4iqQx6RxwDTx8rHJIacUJUPhZjwYccPWe1yeHCoK/AcCm0c7+5OEx2kwIJuJigV19seB1usbyYjjx41E7AtX39CLQ2IyVjf3SGNzHqNyDbdwvQnh+CogcGnDWUolrAPDVmT+FhgAa9FhhooUFmj5tGHBkT6ZrjjDCISkn0kodTB4UDynAWoHYq5cP9g8NKMUVJov9O/eC3vfz4ZiAHB3nqs4BCnO/22Z3b79y6Y/+j2/x4584vKu58MnfHkw956kO+2+9Wev2rcq9V3+s9sYCeVy8PvzZajRM3z+btsju+unX7bK/bZ5PBvFM++cRuT46/3Lnzq/1u66Ls9tuVk09yr9c8093mmezWSyVSIOusktq37+sDqXCOFOpRQ8qJzc/adCcEH9fysiAEIl6M4kHAWUmXSxDCXAq41SUmQydEj4OzwqPnNzEopJ+lL0vjyCo4yRyX4j75pEba7nHdbbZbm3qoT4EHMAiQ1IyK8ZGgSe0bYVIYYFZITKHHDRXSoH2KlULBZsmBppIzO6gwlAap5WzziUZgRqsh7q1+x5EHBj0KNoaRBgIKoRWifVQgNCSHsDBIru22m5gr9E5BQYgGlX3N6x+Fp/Le5UxJLYcm15oJCDnTuXK1kmvEmgvUOtdEYRQE2ZByH4wug9FytUKXwWgajDZlIBU9vGsfVasHpUhkz1nqXZ+5wI7BsARRFHCb4mVeHy5YMfhwJlqzwQWIkTSwB7IakGEEwkpgpZL3M8wm1lBTP+YJ8CPeC8TMovfTLwXOBlx52RB8GoAZShXew/4j5KU2vJHU3b1hLprzmCcMZZBhF422aFQnrvZCft16v/O1vYWrsel6b784YxkrAQG1l3728sW6J3ytv4hQcem9/dqt2THesREIH6la3Jyko6FxnEgiDUtDNKME/12C2ubl7SlgAeaOYs2lyDUDGXu59tlpNkJbgNMFOE3AafvslBbTerobtrxckGbxZ1z74cwm3S/MLul/Zgl/VpvbVeSvLjFfYs4mSSeW6wmbhGz0uYItLqyQXgz3q42DvV2wxFdkuVXH/F+B5+DjWkeb+GR9/R9tBnK0MWijWV/+2/hjejktn4+31v+84CW72xolxHTsEdIeLhsaUsQlFdMpd/UB/It94dVitqhFL3vCuzqmbZSkLIrPJSqZjbIsUlpp/hNKemsFee6Txy90oZ+Typ9yJHMZfoGyeI8/QO1E18z/Pv/vcotd4v76x1/7+9OZ2hYAAA==" /></Footer>{/* END_ACCOUNTING_PAYMENT_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_payments
      parameters:
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaResponse'
  /accounting/v1/payments/remote-field-classes:
    get:
      operationId: remote-field-classes-list
      summary: Remote Field Classes List
      description: Returns a list of `RemoteFieldClass` objects.{/* BEGIN_ACCOUNTING_PAYMENT_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA+1Ya2/iOBT9K8gfEZBpGaiKtFrx6pTuEDotHbU7qqyLcwmGxE5thxZG899XDqFA353NMmh3vxE/zo3vOT73ku+EgUFfqhmpEWBMxsJw4ZMCCaWHAamRU5iFKAwpEIi4CyFuLKTTfVIgOo4iqQx6RxwDTx8rHJIacUJUPhZjwYccPWe1yeHCoK/AcCm0c7+5OEx2kwIJuJigV19seB1usbyYjjx41E7AtX39CLQ2IyVjf3SGNzHqNyDbdwvQnh+CogcGnDWUolrAPDVmT+FhgAa9FhhooUFmj5tGHBkT6ZrjjDCISkn0kodTB4UDynAWoHYq5cP9g8NKMUVJov9O/eC3vfz4ZiAHB3nqs4BCnO/22Z3b79y6Y/+j2/x4584vKu58MnfHkw956kO+2+9Wev2rcq9V3+s9sYCeVy8PvzZajRM3z+btsju+unX7bK/bZ5PBvFM++cRuT46/3Lnzq/1u66Ls9tuVk09yr9c8093mmezWSyVSIOusktq37+sDqXCOFOpRQ8qJzc/adCcEH9fysiAEIl6M4kHAWUmXSxDCXAq41SUmQydEj4OzwqPnNzEopJ+lL0vjyCo4yRyX4j75pEba7nHdbbZbm3qoT4EHMAiQ1IyK8ZGgSe0bYVIYYFZITKHHDRXSoH2KlULBZsmBppIzO6gwlAap5WzziUZgRqsh7q1+x5EHBj0KNoaRBgIKoRWifVQgNCSHsDBIru22m5gr9E5BQYgGlX3N6x+Fp/Le5UxJLYcm15oJCDnTuXK1kmvEmgvUOtdEYRQE2ZByH4wug9FytUKXwWgajDZlIBU9vGsfVasHpUhkz1nqXZ+5wI7BsARRFHCb4mVeHy5YMfhwJlqzwQWIkTSwB7IakGEEwkpgpZL3M8wm1lBTP+YJ8CPeC8TMovfTLwXOBlx52RB8GoAZShXew/4j5KU2vJHU3b1hLprzmCcMZZBhF422aFQnrvZCft16v/O1vYWrsel6b784YxkrAQG1l3728sW6J3ytv4hQcem9/dqt2THesREIH6la3Jyko6FxnEgiDUtDNKME/12C2ubl7SlgAeaOYs2lyDUDGXu59tlpNkJbgNMFOE3AafvslBbTerobtrxckGbxZ1z74cwm3S/MLul/Zgl/VpvbVeSvLjFfYs4mSSeW6wmbhGz0uYItLqyQXgz3q42DvV2wxFdkuVXH/F+B5+DjWkeb+GR9/R9tBnK0MWijWV/+2/hjejktn4+31v+84CW72xolxHTsEdIeLhsaUsQlFdMpd/UB/It94dVitqhFL3vCuzqmbZSkLIrPJSqZjbIsUlpp/hNKemsFee6Txy90oZ+Typ9yJHMZfoGyeI8/QO1E18z/Pv/vcotd4v76x1/7+9OZ2hYAAA==" /></Footer>{/* END_ACCOUNTING_PAYMENT_FETCH_SUPPORTED_FIELDS */}
      tags:
      - subpackage_payments
      parameters:
      - name: cursor
        in: query
        description: The pagination cursor value.
        required: false
        schema:
          type: string
      - name: include_deleted_data
        in: query
        description: Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
        required: false
        schema:
          type: boolean
      - name: include_remote_data
        in: query
        description: Whether to include the original data Merge fetched from the third-party to produce these models.
        required: false
        schema:
          type: boolean
      - name: include_shell_data
        in: query
        description: Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
        required: false
        schema:
          type: boolean
      - name: is_common_model_field
        in: query
        description: If provided, will only return remote field classes with this is_common_model_field value
        required: false
        schema:
          type: boolean
      - name: is_custom
        in: query
        description: If provided, will only return remote fields classes with this is_custom value
        required: false
        schema:
          type: boolean
      - name: page_size
        in: query
        description: Number of results to return per page. The maximum limit is 100.
        required: false
        schema:
          type: integer
      - name: Authorization
        in: header
        description: Token-based authentication with required prefix "Bearer"
        required: true
        schema:
          type: string
      - name: X-Account-Token
        in: header
        description: Token identifying the end user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRemoteFieldClassList'
components:
  schemas:
    ValidationProblemSource:
      type: object
      properties:
        pointer:
          type: string
      required:
      - pointer
      title: ValidationProblemSource
    PaymentTypeEnum:
      type: string
      enum:
      - ACCOUNTS_PAYABLE
      - ACCOUNTS_RECEIVABLE
      title: PaymentTypeEnum
    PaymentFieldMappings:
      type: object
      properties:
        organization_defined_targets:
          type: object
          additionalProperties:
            description: Any type
        linked_account_defined_targets:
          type: object
          additionalProperties:
            description: Any type
      title: PaymentFieldMappings
    ItemTypeEnum:
      type: string
      enum:
      - string
      - number
      - date
      - datetime
      - bool
      - list
      title: ItemTypeEnum
    PatchedPaymentRequest:
      type: object
      properties:
        transaction_date:
          type:
          - string
          - 'null'
          format: date-time
          description: The payment's transaction date.
        contact:
          type:
          - string
          - 'null'
          format: uuid
          description: The supplier, or customer involved in the payment.
        account:
          type:
          - string
          - 'null'
          format: uuid
          description: The supplier’s or customer’s account in which the payment is made.
        payment_method:
          type:
          - string
          - 'null'
          format: uuid
          description: The method which this payment was made by.
        currency:
          oneOf:
          - $ref: '#/components/schemas/TransactionCurrencyEnum'
          - type: 'null'
          description: The payment's currency. The currency code in ISO 4217 format.
        exchange_rate:
          type:
          - string
          - 'null'
          format: decimal
          description: The payment's exchange rate.
        company:
          type:
          - string
          - 'null'
          format: uuid
          description: The company the payment belongs to.
        total_amount:
          type:
          - number
          - 'null'
          format: double
          description: The total amount of money being paid to the supplier, or customer, after taxes.
        type:
          oneOf:
          - $ref: '#/components/schemas/PaymentTypeEnum'
          - type: 'null'
          description: The type of the invoice.
        tracking_categories:
          type: array
          items:
            type: string
            format: uuid
        accounting_period:
          type:
          - string
          - 'null'
          format: uuid
          description: The accounting period that the Payment was generated in.
        applied_to_lines:
          type: array
          items:
            $ref: '#/components/schemas/PaymentLineItemRequest'
          description: A list of “Payment Applied to Lines” objects.
        integration_params:
          type:
          - object
          - 'null'
          additionalProperties:
            description: Any type
        linked_account_params:
          type:
          - object
          - 'null'
          additionalProperties:
            description: Any type
        remote_fields:
          type: array
          items:
            $ref: '#/components/schemas/RemoteFieldRequest'
      description: '# The Payment Object

        ### Description

        The `Payment` object represents general payments made towards a specific transaction.


        ### Usage Example

        Fetch from the `GET Payment` endpoint and view an invoice''s payment.'
      title: PatchedPaymentRequest
    DebugModelLogSummary:
      type: object
      properties:
        url:
          type: string
        method:
          type: string
        status_code:
          type: integer
      required:
      - url
      - method
      - status_code
      title: DebugModelLogSummary
    PaymentResponse:
      type: object
      properties:
        model:
          $ref: '#/components/schemas/Payment'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/WarningValidationProblem'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorValidationProb

# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/openapi/merge-subpackage-payments-api-openapi.yml

Merge subpackage_payments API

Operations 8

Documentation

Specifications

Schemas & Data

Other Resources