/vendor-credits/{id}/application

POST

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

POST

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

curl -X POST https://api.merge.dev/api/accounting/v1/vendor-credits/id/application \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "invoice": "string",
  "applied_date": "2024-01-15T09:30:00Z",
  "applied_amount": "string"
}'

201Created

{
  "model": {
    "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"
      }
    ],
    "accounting_period": "9b840d2-686a-465a-8a8e-7b028498f8e4",
    "vendor_credit_url": "https://qbo.intuit.com/app/vendorcredit/088899",
    "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
      }
    ]
  },
  "warnings": [
    {
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD",
      "source": {
        "pointer": "/age"
      },
      "block_merge_link": true,
      "raw_error": "string",
      "error_code": 1
    }
  ],
  "errors": [
    {
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD",
      "source": {
        "pointer": "/model/custom_fields"
      },
      "block_merge_link": true,
      "raw_error": "string",
      "error_code": 1
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "www.exampleintegration.com/api/v1/exampleapi",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Creates a new VendorCreditApplyLine to apply a vendor credit to an invoice

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Query parameters

is_debug_modebooleanOptional

Whether to include debug fields (such as log file links) in the response.

run_asyncbooleanOptional

Whether or not third-party updates should be run asynchronously.

Request

This endpoint expects an object.

invoicestring or nullRequiredformat: "uuid"

The invoice to apply the vendor credit to.

applied_datedatetimeRequired

Date that the vendor credit is applied to the invoice.

applied_amountstringRequiredformat: "decimal"

The amount of vendor credit applied to the invoice.

Response

modelobject

Description

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.

Usage Example

Fetch from the GET VendorCredit endpoint and view a company’s vendor credits.

warningslist of objects

errorslist of objects

logslist of objectsOptional