/payments/{id}

Returns a Payment object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

expandenumOptional

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

idstringRead-onlyformat: "uuid"

remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only

The datetime that this object was created by Merge.

modified_atdatetimeRead-only

The datetime that this object was modified by Merge.

transaction_datedatetime or null

The payment's transaction date.

contactstring or nullformat: "uuid"

The supplier, or customer involved in the payment.

accountstring or nullformat: "uuid"

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

payment_methodstring or nullformat: "uuid"

The method which this payment was made by.

currencyenum or null

The payment's currency. The currency code in ISO 4217 format.

exchange_ratestring or nullformat: "decimal"

The payment's exchange rate.

companystring or nullformat: "uuid"

The company the payment belongs to.

total_amountdouble or null

The total amount of money being paid to the supplier, or customer, after taxes.

typeenum or null

The type of the invoice.

ACCOUNTS_PAYABLE - ACCOUNTS_PAYABLE
ACCOUNTS_RECEIVABLE - ACCOUNTS_RECEIVABLE

The type of the invoice. * `ACCOUNTS_PAYABLE` - ACCOUNTS_PAYABLE * `ACCOUNTS_RECEIVABLE` - ACCOUNTS_RECEIVABLE

Allowed values:

tracking_categorieslist of strings

accounting_periodstring or nullformat: "uuid"

The accounting period that the Payment was generated in.

applied_to_lineslist of objects

A list of “Payment Applied to Lines” objects.

remote_updated_atdatetime or null

When the third party's payment entry was updated.

remote_was_deletedbooleanRead-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 nullRead-only

remote_datalist of objects or nullRead-only

remote_fieldslist of objectsRead-only

1	from merge import Merge
2
3	client = Merge(
4	account_token="YOUR_ACCOUNT_TOKEN",
5	api_key="YOUR_API_KEY",
6	)
7	client.accounting.payments.retrieve(
8	id="id",
9	)

1	{
2	"id": "b26fd49a-cbae-470a-a8f8-bcbc119e0390",
3	"remote_id": "987300",
4	"created_at": "2021-09-15T00:00:00Z",
5	"modified_at": "2021-10-16T00:00:00Z",
6	"transaction_date": "2020-03-31T00:00:00Z",
7	"contact": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
8	"account": "d6e687d6-0c36-48a1-8114-35324b5cb38f",
9	"payment_method": "9394320-8864-2343-4343-9008789",
10	"currency": "FKP",
11	"exchange_rate": "2.9",
12	"company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
13	"total_amount": 50,
14	"type": "ACCOUNTS_PAYABLE",
15	"tracking_categories": [
16	"b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
17	"9b840d2-686a-465a-8a8e-7b028498f8e4",
18	"a47e11b6-c73b-4a0c-be31-130fc48177fa"
19	],
20	"accounting_period": "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
21	"applied_to_lines": [
22	{
23	"remote_id": "234",
24	"applied_amount": "25",
25	"applied_date": "2020-03-31T00:00:00Z",
26	"related_object_id": "a47e11b6-c73b-4a0c-be31-130fc48177fa",
27	"related_object_type": "INVOICE"
28	},
29	{
30	"remote_id": "235",
31	"applied_amount": "25",
32	"applied_date": "2020-03-31T00:00:00Z",
33	"related_object_id": "9b96a886-29a5-452b-8733-2a1e03497cf4",
34	"related_object_type": "CREDIT_NOTE"
35	}
36	],
37	"remote_updated_at": "2020-03-31T00:00:00Z",
38	"remote_was_deleted": true,
39	"field_mappings": {
40	"organization_defined_targets": {
41	"custom_key": "custom_value"
42	},
43	"linked_account_defined_targets": {
44	"custom_key": "custom_value"
45	}
46	},
47	"remote_data": [
48	{
49	"path": "/actions"
50	}
51	],
52	"remote_fields": [
53	{
54	"remote_field_class": {
55	"id": "string",
56	"display_name": "string",
57	"remote_key_name": "string",
58	"description": "string",
59	"is_custom": true,
60	"is_common_model_field": true,
61	"is_required": true,
62	"field_type": "string",
63	"field_format": "string",
64	"field_choices": [
65	"string"
66	],
67	"item_schema": {
68	"item_type": "string",
69	"item_format": "string",
70	"item_choices": [
71	"string"
72	]
73	}
74	},
75	"value": "string"
76	}
77	]
78	}

/payments/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration