For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Payment object
          • GET/payments
          • POST/payments
          • GET/payments/{id}
          • PATCH/payments/{id}
          • GET/payments/line-items/remote-field-classes
          • GET/payments/meta/patch/{id}
          • GET/payments/meta/post
          • GET/payments/remote-field-classes

Get started

  • Overview
  • Introduction
  • Unified API
  • Linked Account
  • Merge Link
  • Use cases

Implementation

  • Sandboxes
  • SDKs
  • API access
  • Syncing data
  • Writing data
  • Data minimization
  • Supplemental data
  • Errors
  • Integration metadata

API reference

  • ATS
  • HRIS
  • Accounting
  • Ticketing
  • CRM
  • File Storage
  • Knowledge Base
  • Chat

Resources

  • Help Center
  • Merge.dev
  • Changelog
© Merge 2026Terms of usePrivacy policy
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsPayments

The Payment object

The Payment Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "transaction_date": "2023-01-01T00:00:00Z",
7  "contact": "string",
8  "account": "string",
9  "payment_method": "string",
10  "currency": "XUA",
11  "exchange_rate": "string",
12  "company": "string",
13  "total_amount": 1,
14  "type": "ACCOUNTS_PAYABLE",
15  "tracking_categories": [
16    "string"
17  ],
18  "accounting_period": "string",
19  "applied_to_lines": [
20    {
21      "id": "string",
22      "remote_id": "string",
23      "created_at": "2023-01-01T00:00:00Z",
24      "modified_at": "2023-01-01T00:00:00Z",
25      "applied_amount": "string",
26      "applied_date": "2023-01-01T00:00:00Z",
27      "related_object_id": "string",
28      "related_object_type": "string"
29    }
30  ],
31  "remote_updated_at": "2023-01-01T00:00:00Z",
32  "remote_was_deleted": true,
33  "field_mappings": {
34    "organization_defined_targets": {
35      "string": {}
36    },
37    "linked_account_defined_targets": {
38      "string": {}
39    }
40  },
41  "remote_data": [
42    {
43      "path": "string",
44      "data": {}
45    }
46  ],
47  "remote_fields": [
48    {
49      "remote_field_class": {
50        "id": "string",
51        "display_name": "string",
52        "remote_key_name": "string",
53        "description": "string",
54        "is_custom": true,
55        "is_common_model_field": true,
56        "is_required": true,
57        "field_type": "string",
58        "field_format": "string",
59        "field_choices": [
60          "string"
61        ],
62        "item_schema": {
63          "item_type": "string",
64          "item_format": "string",
65          "item_choices": [
66            "string"
67          ]
68        }
69      },
70      "value": {
71        "string": {}
72      }
73    }
74  ]
75}
Was this page helpful?
Previous

/payment-terms/{id}

Next

/payments

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

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional
created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
transaction_datedatetime or nullOptional
The payment's transaction date.
contactstring or nullOptionalformat: "uuid"
The supplier, or customer involved in the payment.
accountstring or nullOptionalformat: "uuid"
payment_methodstring or nullOptionalformat: "uuid"
The method which this payment was made by.
currencyenum or nullOptional
The payment's currency. The currency code in ISO 4217 format.
exchange_ratestring or nullOptionalformat: "decimal"
The payment's exchange rate.
companystring or nullOptionalformat: "uuid"
The company the payment belongs to.
total_amountdouble or nullOptional
The total amount of money being paid to the supplier, or customer, after taxes.
typeenum or nullOptional
The type of the invoice.
Allowed values:
tracking_categorieslist of stringsOptional
accounting_periodstring or nullOptionalformat: "uuid"
The accounting period that the Payment was generated in.
applied_to_lineslist of objectsOptional
remote_updated_atdatetime or nullOptional
When the third party's payment entry was updated.
remote_was_deletedbooleanOptionalRead-only
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only
remote_fieldslist of objectsOptionalRead-only