/vendor-credits/{id}

GET

/accounting/v1/vendor-credits/:id

GET

/api/accounting/v1/vendor-credits/:id

$ curl -G https://api.merge.dev/api/accounting/v1/vendor-credits/id \
>      -H "X-Account-Token: X-Account-Token" \
>      -H "Authorization: Bearer <token>" \
>      -d expand=accounting_period

200Retrieved

1 {
2   "id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
3   "remote_id": "088899",
4   "created_at": "2021-09-15T00:00:00Z",
5   "modified_at": "2021-10-16T00:00:00Z",
6   "number": "6",
7   "transaction_date": "2020-03-31T00:00:00Z",
8   "vendor": "3d263469-51a1-4766-9205-f6c997826be1",
9   "total_amount": 10000,
10   "currency": "USD",
11   "exchange_rate": "2.9",
12   "inclusive_of_tax": true,
13   "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
14   "lines": [
15     {
16       "remote_id": "121222",
17       "net_amount": 25.54,
18       "tracking_categories": [
19         "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
20         "9b840d2-686a-465a-8a8e-7b028498f8e4",
21         "a47e11b6-c73b-4a0c-be31-130fc48177fa"
22       ],
23       "description": "Gifted Merge Credit",
24       "account": "9d892439-5fab-4dbb-8bd8-34f7f96c7912",
25       "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
26       "project": "22e65a5d-2df5-4e6e-884a-e538d0339000",
27       "contact": "908934-49j9-093f-0989-908923908",
28       "tax_rate": "a12e7c20-1922-9df7-s75n-edfeewnn7384",
29       "exchange_rate": "2.9",
30       "remote_was_deleted": false
31     },
32     {
33       "remote_id": "121223",
34       "net_amount": 10,
35       "tracking_categories": [
36         "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
37         "9b840d2-686a-465a-8a8e-7b028498f8e4",
38         "a47e11b6-c73b-4a0c-be31-130fc48177fa"
39       ],
40       "description": "Refund for overpayment",
41       "account": "9d892439-5fab-4dbb-8bd8-34f7f96c7912"
42     }
43   ],
44   "tracking_categories": [
45     "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
46     "9b840d2-686a-465a-8a8e-7b028498f8e4",
47     "a47e11b6-c73b-4a0c-be31-130fc48177fa"
48   ],
49   "applied_to_lines": [
50     {
51       "invoice": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
52       "applied_date": "2020-03-31T00:00:00Z",
53       "applied_amount": "2.9"
54     }
55   ],
56   "accounting_period": "9b840d2-686a-465a-8a8e-7b028498f8e4",
57   "vendor_credit_url": "https://qbo.intuit.com/app/vendorcredit/088899",
58   "remote_was_deleted": true,
59   "field_mappings": {
60     "organization_defined_targets": {
61       "custom_key": "custom_value"
62     },
63     "linked_account_defined_targets": {
64       "custom_key": "custom_value"
65     }
66   },
67   "remote_data": [
68     {
69       "path": "/actions",
70       "data": null
71     }
72   ]
73 }

Returns a VendorCredit 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.

Allowed values:

include_remote_databooleanOptional

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

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.

numberstring or nullOptional

The vendor credit's number.

transaction_datedatetime or nullOptional

The vendor credit's transaction date.

vendorstring or nullOptionalformat: "uuid"

The vendor that owes the gift or refund.

total_amountdouble or nullOptional

The vendor credit's total amount.

currencyenum or nullOptional

The vendor credit's currency. The currency code in ISO 4217 format.

exchange_ratestring or nullOptionalformat: "decimal"

The vendor credit's exchange rate.

inclusive_of_taxboolean or nullOptional

If the transaction is inclusive or exclusive of tax. True if inclusive, False if exclusive.

companystring or nullOptionalformat: "uuid"

The company the vendor credit belongs to.

lineslist of objectsOptionalRead-only

tracking_categorieslist of stringsOptional

applied_to_lineslist of objectsOptional

A list of VendorCredit Applied to Lines objects.

accounting_periodstring or nullOptionalformat: "uuid"

The accounting period that the VendorCredit was generated in.

vendor_credit_urlstring or nullOptionalformat: "uri"<=2000 characters

The 3rd party URL of the vendor credit.

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