/vendor-credits/{id}

import { MergeClient } from "@mergeapi/merge-node-client";
const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
await client.accounting.vendorCredits.retrieve("id", {
    includeRemoteData: true,
    includeShellData: true
});

{
  "id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
  "remote_id": "088899",
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
  "number": "6",
  "transaction_date": "2020-03-31T00:00:00Z",
  "vendor": "3d263469-51a1-4766-9205-f6c997826be1",
  "total_amount": 10000,
  "currency": "USD",
  "exchange_rate": "2.9",
  "inclusive_of_tax": true,
  "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
  "lines": [
    {
      "remote_id": "121222",
      "net_amount": 25.54,
      "tracking_categories": [
        "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
        "9b840d2-686a-465a-8a8e-7b028498f8e4",
        "a47e11b6-c73b-4a0c-be31-130fc48177fa"
      ],
      "description": "Gifted Merge Credit",
      "account": "9d892439-5fab-4dbb-8bd8-34f7f96c7912",
      "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
      "project": "22e65a5d-2df5-4e6e-884a-e538d0339000",
      "contact": "908934-49j9-093f-0989-908923908",
      "tax_rate": "a12e7c20-1922-9df7-s75n-edfeewnn7384",
      "exchange_rate": "2.9",
      "remote_was_deleted": false
    },
    {
      "remote_id": "121223",
      "net_amount": 10,
      "tracking_categories": [
        "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
        "9b840d2-686a-465a-8a8e-7b028498f8e4",
        "a47e11b6-c73b-4a0c-be31-130fc48177fa"
      ],
      "description": "Refund for overpayment",
      "account": "9d892439-5fab-4dbb-8bd8-34f7f96c7912"
    }
  ],
  "tracking_categories": [
    "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
    "9b840d2-686a-465a-8a8e-7b028498f8e4",
    "a47e11b6-c73b-4a0c-be31-130fc48177fa"
  ],
  "applied_to_lines": [
    {
      "invoice": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
      "applied_date": "2020-03-31T00:00:00Z",
      "applied_amount": "2.9"
    }
  ],
  "remote_was_deleted": true,
  "accounting_period": "9b840d2-686a-465a-8a8e-7b028498f8e4",
  "field_mappings": {
    "organization_defined_targets": {
      "custom_key": "custom_value"
    },
    "linked_account_defined_targets": {
      "custom_key": "custom_value"
    }
  },
  "remote_data": [
    {
      "path": "/actions"
    }
  ]
}

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

numberstring or null

The vendor credit's number.

transaction_datedatetime or null

The vendor credit's transaction date.

vendorstring or nullformat: "uuid"

The vendor that owes the gift or refund.

total_amountdouble or null

The vendor credit's total amount.

currencyenum or null

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

exchange_ratestring or nullformat: "decimal"

The vendor credit's exchange rate.

inclusive_of_taxboolean or null

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

companystring or nullformat: "uuid"

The company the vendor credit belongs to.

lineslist of objectsRead-only

tracking_categorieslist of strings

applied_to_lineslist of objects

A list of VendorCredit Applied to Lines objects.

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.

accounting_periodstring or nullformat: "uuid"

The accounting period that the VendorCredit was generated in.

field_mappingsobject or nullRead-only

remote_datalist of objects or nullRead-only

/vendor-credits/{id}

Authentication

Path parameters

Headers

Query parameters

Response

Field support by integration