/payments/{id}

GET

/accounting/v1/payments/:id

GET

/api/accounting/v1/payments/:id

curl -G https://api.merge.dev/api/accounting/v1/payments/id \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -d include_remote_data=true

200Retrieved

{
  "id": "b26fd49a-cbae-470a-a8f8-bcbc119e0390",
  "remote_id": "987300",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
  "transaction_date": "2020-03-31T00:00:00Z",
  "contact": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
  "account": "d6e687d6-0c36-48a1-8114-35324b5cb38f",
  "payment_method": "9394320-8864-2343-4343-9008789",
  "currency": "FKP",
  "exchange_rate": "2.9",
  "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
  "total_amount": 50,
  "type": "ACCOUNTS_PAYABLE",
  "tracking_categories": [
    "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
    "9b840d2-686a-465a-8a8e-7b028498f8e4",
    "a47e11b6-c73b-4a0c-be31-130fc48177fa"
  ],
  "accounting_period": "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
  "applied_to_lines": [
    {
      "remote_id": "234",
      "applied_amount": "25",
      "applied_date": "2020-03-31T00:00:00Z",
      "related_object_id": "a47e11b6-c73b-4a0c-be31-130fc48177fa",
      "related_object_type": "INVOICE"
    },
    {
      "remote_id": "235",
      "applied_amount": "25",
      "applied_date": "2020-03-31T00:00:00Z",
      "related_object_id": "9b96a886-29a5-452b-8733-2a1e03497cf4",
      "related_object_type": "CREDIT_NOTE"
    }
  ],
  "remote_updated_at": "2020-03-31T00:00:00Z",
  "payment_url": "https://qbo.intuit.com/app/payment/987300",
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  },
  "remote_data": [
    {
      "path": "/actions",
      "data": null
    }
  ],
  "remote_fields": [
    {
      "remote_field_class": {
        "id": "string",
        "display_name": "string",
        "remote_key_name": "string",
        "description": "string",
        "is_custom": true,
        "is_common_model_field": true,
        "is_required": true,
        "field_type": "string",
        "field_format": "string",
        "field_choices": [
          "string"
        ],
        "item_schema": {
          "item_type": "string",
          "item_format": "string",
          "item_choices": [
            "string"
          ]
        }
      },
      "value": "string"
    }
  ]
}

Returns a Payment object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandlist of enumsOptional

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_remote_fieldsbooleanOptional

Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstringOptionalRead-onlyformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

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"

The supplier’s or customer’s account in which the payment is made.

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.

tracking_categorieslist of stringsOptional

accounting_periodstring or nullOptionalformat: "uuid"

The accounting period that the Payment was generated in.

applied_to_lineslist of objectsOptional

A list of “Payment Applied to Lines” objects.

remote_updated_atdatetime or nullOptional

When the third party's payment entry was updated.

payment_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party URL of the payment.

remote_was_deletedbooleanOptionalRead-only

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.

field_mappingsobject or nullOptionalRead-only

remote_datalist of objects or nullOptionalRead-only

remote_fieldslist of objectsOptionalRead-only