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 VendorCredit object
          • GET/vendor-credits
          • POST/vendor-credits
          • GET/vendor-credits/{id}
          • PATCH/vendor-credits/{id}
          • POST/vendor-credits/{id}/application
          • GET/vendor-credits/meta/patch/{id}
          • GET/vendor-credits/meta/post
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsVendor Credits

The VendorCredit object

The VendorCredit 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  "number": "string",
7  "transaction_date": "2023-01-01T00:00:00Z",
8  "vendor": "string",
9  "total_amount": 1,
10  "currency": "XUA",
11  "exchange_rate": "string",
12  "inclusive_of_tax": true,
13  "company": "string",
14  "lines": [
15    {
16      "id": "string",
17      "remote_id": "string",
18      "created_at": "2023-01-01T00:00:00Z",
19      "modified_at": "2023-01-01T00:00:00Z",
20      "net_amount": 1,
21      "tracking_category": "string",
22      "tracking_categories": [
23        "string"
24      ],
25      "description": "string",
26      "account": "string",
27      "company": "string",
28      "project": "string",
29      "contact": "string",
30      "tax_rate": "string",
31      "exchange_rate": "string",
32      "remote_was_deleted": true
33    }
34  ],
35  "tracking_categories": [
36    "string"
37  ],
38  "applied_to_lines": [
39    {
40      "remote_id": "string",
41      "created_at": "2023-01-01T00:00:00Z",
42      "modified_at": "2023-01-01T00:00:00Z",
43      "invoice": "string",
44      "applied_date": "2023-01-01T00:00:00Z",
45      "applied_amount": "string",
46      "remote_was_deleted": true
47    }
48  ],
49  "remote_was_deleted": true,
50  "accounting_period": "string",
51  "field_mappings": {},
52  "remote_data": [
53    {
54      "path": "string",
55      "data": {}
56    }
57  ]
58}
Was this page helpful?
Previous

/transactions/{id}

Next

/vendor-credits

Built with

A VendorCredit is transaction issued by a vendor to the accounting company, indicating a reduction or cancellation of the amount owed to the vendor. It is most generally used as an adjustment note used to rectify errors, returns, or overpayments related to a purchasing transaction. A VendorCredit can be applied to Accounts Payable Invoices to decrease the overall amount of the Invoice.

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.
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.

accounting_periodstring or nullOptionalformat: "uuid"
The accounting period that the VendorCredit was generated in.
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only