> This page is for Unified.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.merge.dev/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server.

# /credit-notes/{id}/application

POST https://api.merge.dev/api/accounting/v1/credit-notes/{id}/application
Content-Type: application/json

Creates a new CreditNoteApplyLine to apply a credit note to an invoice

Reference: https://docs.merge.dev/merge-unified/accounting/common-models/credit-notes/application-create

## Authentication

- `Authorization` header (bearer token, required) — Token-based authentication with required prefix "Bearer"

## Servers

- `https://api.merge.dev/api` (Production, default)
- `https://api-eu.merge.dev/api` (ProductionEU)
- `https://api-ap.merge.dev/api` (ProductionAPSE1)

## Request

### Path parameters

- `id` (string, required)

### Query parameters

- `is_debug_mode` (boolean, optional) — Whether to include debug fields (such as log file links) in the response.
- `run_async` (boolean, optional) — Whether or not third-party updates should be run asynchronously.

### Headers

- `X-Account-Token` (string, required) — Token identifying the end user.

### Body (application/json)

This endpoint expects an ApplyCreditNoteRequest.

- `invoice` (string, required, nullable) — The invoice to apply the credit note to.
- `applied_date` (datetime, required) — Date that the credit note is applied to the invoice.
- `applied_amount` (string, required) — The amount of credit applied to the invoice.

## Response

### 201

- `model` (CreditNote, required) — # The CreditNote Object ### Description A `CreditNote` is transaction issued to a customer, indicating a reduction or cancellation of the amount owed by the customer. It is most generally used as an adjustment note used to rectify errors, returns, or overpayments related to a sales transaction. A `CreditNote` can be applied to *Accounts Receivable* Invoices to decrease the overall amount of the Invoice. ### Usage Example Fetch from the `LIST CreditNotes` endpoint and view a company's credit notes.
- `warnings` (list of WarningValidationProblem, required)
- `errors` (list of ErrorValidationProblem, required)
- `logs` (list of DebugModeLog, optional)

## Types

### CreditNote

# The CreditNote Object ### Description A `CreditNote` is transaction issued to a customer, indicating a reduction or cancellation of the amount owed by the customer. It is most generally used as an adjustment note used to rectify errors, returns, or overpayments related to a sales transaction. A `CreditNote` can be applied to *Accounts Receivable* Invoices to decrease the overall amount of the Invoice. ### Usage Example Fetch from the `LIST CreditNotes` endpoint and view a company's credit notes.

- `id` (string, optional)
- `remote_id` (string, optional, nullable) — The third-party API ID of the matching object.
- `created_at` (datetime, optional) — The datetime that this object was created by Merge.
- `modified_at` (datetime, optional) — The datetime that this object was modified by Merge.
- `transaction_date` (datetime, optional, nullable) — The credit note's transaction date.
- `status` (enum, optional, nullable) — The credit note's status. This field is an open enum: Merge can return a value outside this list when an integration provides one it does not map. Pass `show_enum_origins=status` to receive the integration's own value instead.
  - Allowed values: `SUBMITTED`, `AUTHORIZED`, `PAID`
- `number` (string, optional, nullable) — The credit note's number.
- `contact` (string, optional, nullable) — The credit note's contact.
- `company` (string, optional, nullable) — The company the credit note belongs to.
- `exchange_rate` (string, optional, nullable) — The credit note's exchange rate.
- `total_amount` (double, optional, nullable) — The credit note's total amount.
- `remaining_credit` (double, optional, nullable) — The amount of value remaining in the credit note that the customer can use.
- `inclusive_of_tax` (boolean, optional, nullable) — If the transaction is inclusive or exclusive of tax. `True` if inclusive, `False` if exclusive.
- `line_items` (list of CreditNoteLineItem, optional)
- `tracking_categories` (list of string, optional)
- `currency` (enum, optional, nullable) — The credit note's currency. The currency code in ISO 4217 format.
  - Allowed values: `XUA`, `AFN`, `AFA`, `ALL`, `ALK`, `DZD`, `ADP`, `AOA`, `AOK`, `AON`, `AOR`, `ARA`, `ARS`, `ARM`, `ARP`, `ARL`, `AMD`, `AWG`, `AUD`, `ATS`, `AZN`, `AZM`, `BSD`, `BHD`, `BDT`, `BBD`, `BYN`, `BYB`, `BYR`, `BEF`, `BEC`, `BEL`, `BZD`, `BMD`, `BTN`, `BOB`, `BOL`, `BOV`, `BOP`, `BAM`, `BAD`, `BAN`, `BWP`, `BRC`, `BRZ`, `BRE`, `BRR`, `BRN`, `BRB`, `BRL`, `GBP`, `BND`, `BGL`, `BGN`, `BGO`, `BGM`, `BUK`, `BIF`, `XPF`, `KHR`, `CAD`, `CVE`, `KYD`, `XAF`, `CLE`, `CLP`, `CLF`, `CNX`, `CNY`, `CNH`, `COP`, `COU`, `KMF`, `CDF`, `CRC`, `HRD`, `HRK`, `CUC`, `CUP`, `CYP`, `CZK`, `CSK`, `DKK`, `DJF`, `DOP`, `NLG`, `XCD`, `DDM`, `ECS`, `ECV`, `EGP`, `GQE`, `ERN`, `EEK`, `ETB`, `EUR`, `XBA`, `XEU`, `XBB`, `XBC`, `XBD`, `FKP`, `FJD`, `FIM`, `FRF`, `XFO`, `XFU`, `GMD`, `GEK`, `GEL`, `DEM`, `GHS`, `GHC`, `GIP`, `XAU`, `GRD`, `GTQ`, `GWP`, `GNF`, `GNS`, `GYD`, `HTG`, `HNL`, `HKD`, `HUF`, `IMP`, `ISK`, `ISJ`, `INR`, `IDR`, `IRR`, `IQD`, `IEP`, `ILS`, `ILP`, `ILR`, `ITL`, `JMD`, `JPY`, `JOD`, `KZT`, `KES`, `KWD`, `KGS`, `LAK`, `LVL`, `LVR`, `LBP`, `LSL`, `LRD`, `LYD`, `LTL`, `LTT`, `LUL`, `LUC`, `LUF`, `MOP`, `MKD`, `MKN`, `MGA`, `MGF`, `MWK`, `MYR`, `MVR`, `MVP`, `MLF`, `MTL`, `MTP`, `MRU`, `MRO`, `MUR`, `MXV`, `MXN`, `MXP`, `MDC`, `MDL`, `MCF`, `MNT`, `MAD`, `MAF`, `MZE`, `MZN`, `MZM`, `MMK`, `NAD`, `NPR`, `ANG`, `TWD`, `NZD`, `NIO`, `NIC`, `NGN`, `KPW`, `NOK`, `OMR`, `PKR`, `XPD`, `PAB`, `PGK`, `PYG`, `PEI`, `PEN`, `PES`, `PHP`, `XPT`, `PLN`, `PLZ`, `PTE`, `GWE`, `QAR`, `XRE`, `RHD`, `RON`, `ROL`, `RUB`, `RUR`, `RWF`, `SVC`, `WST`, `SAR`, `RSD`, `CSD`, `SCR`, `SLL`, `XAG`, `SGD`, `SKK`, `SIT`, `SBD`, `SOS`, `ZAR`, `ZAL`, `KRH`, `KRW`, `KRO`, `SSP`, `SUR`, `ESP`, `ESA`, `ESB`, `XDR`, `LKR`, `SHP`, `XSU`, `SDD`, `SDG`, `SDP`, `SRD`, `SRG`, `SZL`, `SEK`, `CHF`, `SYP`, `STN`, `STD`, `TVD`, `TJR`, `TJS`, `TZS`, `XTS`, `THB`, `XXX`, `TPE`, `TOP`, `TTD`, `TND`, `TRY`, `TRL`, `TMT`, `TMM`, `USD`, `USN`, `USS`, `UGX`, `UGS`, `UAH`, `UAK`, `AED`, `UYW`, `UYU`, `UYP`, `UYI`, `UZS`, `VUV`, `VES`, `VEB`, `VEF`, `VND`, `VNN`, `CHE`, `CHW`, `XOF`, `YDD`, `YER`, `YUN`, `YUD`, `YUM`, `YUR`, `ZWN`, `ZRN`, `ZRZ`, `ZMW`, `ZMK`, `ZWD`, `ZWR`, `ZWL`
- `remote_created_at` (datetime, optional, nullable) — When the third party's credit note was created.
- `remote_updated_at` (datetime, optional, nullable) — When the third party's credit note was updated.
- `payments` (list of string, optional) — Array of `Payment` object IDs
- `applied_payments` (list of string, optional) — A list of the Payment Applied to Lines common models related to a given Invoice, Credit Note, or Journal Entry.
- `accounting_period` (string, optional, nullable) — The accounting period that the CreditNote was generated in.
- `applied_to_lines` (list of CreditNoteApplyLineForCreditNote, optional) — A list of the CreditNote Applied to Lines common models related to a given Credit Note
- `credit_note_url` (string, optional, nullable) — The 3rd party URL of the credit note.
- `remote_was_deleted` (boolean, optional) — 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](https://docs.merge.dev/integrations/hris/supported-features/).
- `field_mappings` (CreditNoteFieldMappings, optional, nullable)
- `remote_data` (list of RemoteData, optional, nullable)

### WarningValidationProblem

- `title` (string, required)
- `detail` (string, required)
- `problem_type` (string, required)
- `source` (ValidationProblemSource, optional)
- `block_merge_link` (boolean, optional)
- `raw_error` (string, optional)
- `error_code` (integer, optional)

### ErrorValidationProblem

- `title` (string, required)
- `detail` (string, required)
- `problem_type` (string, required)
- `source` (ValidationProblemSource, optional)
- `block_merge_link` (boolean, optional)
- `raw_error` (string, optional)
- `error_code` (integer, optional)

### DebugModeLog

- `log_id` (string, required)
- `dashboard_view` (string, required)
- `log_summary` (DebugModelLogSummary, required)

### CreditNoteLineItem

# The CreditNoteLineItem Object ### Description The `CreditNoteLineItem` object is used to represent a credit note's line items. ### Usage Example Fetch from the `GET CreditNote` endpoint and view the credit note's line items.

- `id` (string, optional)
- `remote_id` (string, optional, nullable) — The third-party API ID of the matching object.
- `created_at` (datetime, optional) — The datetime that this object was created by Merge.
- `modified_at` (datetime, optional) — The datetime that this object was modified by Merge.
- `item` (string, optional, nullable)
- `name` (string, optional, nullable) — The credit note line item's name.
- `description` (string, optional, nullable) — The description of the item that is owed.
- `quantity` (string, optional, nullable) — The credit note line item's quantity.
- `memo` (string, optional, nullable) — The credit note line item's memo.
- `unit_price` (string, optional, nullable) — The credit note line item's unit price.
- `tax_rate` (string, optional, nullable) — The tax rate that applies to this line item.
- `total_line_amount` (string, optional, nullable) — The credit note line item's total.
- `tracking_categories` (list of string, optional) — The credit note line item's associated tracking categories.
- `account` (string, optional, nullable) — The credit note line item's account.
- `company` (string, optional, nullable) — The company the credit note belongs to.
- `contact` (string, optional, nullable) — The credit note's contact.
- `project` (string, optional, nullable)
- `remote_was_deleted` (boolean, optional) — 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](https://docs.merge.dev/integrations/hris/supported-features/).
- `tracking_category` (string, optional, nullable, deprecated) — The credit note line item's associated tracking category.

### CreditNoteApplyLineForCreditNote

# The CreditNoteApplyLine Object ### Description The `CreditNoteApplyLine` is attached to the CreditNote model. ### Usage Example Fetch from the `GET CreditNote` endpoint and view the invoice's applied to lines.

- `remote_id` (string, optional, nullable) — The third-party API ID of the matching object.
- `created_at` (datetime, optional) — The datetime that this object was created by Merge.
- `modified_at` (datetime, optional) — The datetime that this object was modified by Merge.
- `invoice` (string, optional, nullable)
- `applied_date` (datetime, optional, nullable) — Date that the credit note is applied to the invoice.
- `applied_amount` (string, optional, nullable) — The amount of the Credit Note applied to the invoice.
- `remote_was_deleted` (boolean, optional) — 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](https://docs.merge.dev/integrations/hris/supported-features/).

### CreditNoteFieldMappings

- `organization_defined_targets` (map from string to any, optional)
- `linked_account_defined_targets` (map from string to any, optional)

### RemoteData

# The RemoteData Object ### Description The `RemoteData` object is used to represent the full data pulled from the third-party API for an object. ### Usage Example TODO

- `path` (string, required) — The third-party API path that is being called.
- `data` (any, optional) — The data returned from the third-party for this object in its original, unnormalized format.

### ValidationProblemSource

- `pointer` (string, required)

### DebugModelLogSummary

- `url` (string, required)
- `method` (string, required)
- `status_code` (integer, required)

## Examples

**Request**

```json
{
  "invoice": "string",
  "applied_date": "2024-01-15T09:30:00Z",
  "applied_amount": "string"
}
```

**Response**

```json
{
  "model": {
    "id": "8d9fd929-436c-4fd4-a48b-0c61f68d6178",
    "remote_id": "123877",
    "created_at": "2021-09-15T00:00:00Z",
    "modified_at": "2021-10-16T00:00:00Z",
    "transaction_date": "2020-03-31T00:00:00Z",
    "status": "PAID",
    "number": "CN-29",
    "contact": "c6c7b870-bb4d-489a-921e-2f0ee4192ff9",
    "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
    "exchange_rate": "2.9",
    "total_amount": 50,
    "remaining_credit": 20,
    "inclusive_of_tax": true,
    "line_items": [
      {
        "remote_id": "121222",
        "item": "0e3fd929-436c-4fd4-a48b-0c61f68d6178",
        "name": "Basic Monthly",
        "description": "prorated amount for items",
        "quantity": "1",
        "memo": "privNote",
        "unit_price": "5.0",
        "tax_rate": "8d9fd929-436c-4fd4-a48b-0c61f68d6178",
        "total_line_amount": "5.0",
        "tracking_categories": [
          "8d9fd929-436c-4fd4-a48b-0c61f68d6178",
          "9b840d2-686a-465a-8a8e-7b028498f8e4",
          "a47e11b6-c73b-4a0c-be31-130fc48177fa"
        ],
        "account": "8d9fd929-436c-4fd4-a48b-0c61f68d6178",
        "company": "595c8f97-2ac4-45b7-b000-41bdf43240b5",
        "contact": "908934-49j9-093f-0989-908923908",
        "project": "22e65a5d-2df5-4e6e-884a-e538d0339000",
        "remote_was_deleted": true
      }
    ],
    "tracking_categories": [
      "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
      "9b840d2-686a-465a-8a8e-7b028498f8e4",
      "a47e11b6-c73b-4a0c-be31-130fc48177fa"
    ],
    "currency": "USD",
    "remote_created_at": "2020-03-31T00:00:00Z",
    "remote_updated_at": "2020-03-31T00:00:00Z",
    "payments": [
      "b26fd49a-cbae-470a-a8f8-bcbc119e0390"
    ],
    "applied_payments": [
      "a9a94a75-19c1-41fe-90d8-d9ba959c38e5"
    ],
    "accounting_period": "b38c59b0-a9d7-4740-b1ee-5436c6751e3d",
    "applied_to_lines": [
      {
        "invoice": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
        "applied_date": "2020-03-31T00:00:00Z",
        "applied_amount": "2.9"
      }
    ],
    "credit_note_url": "https://qbo.intuit.com/app/creditnote/123877",
    "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
      }
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.merge.dev/api/accounting/v1/credit-notes/id/application"

payload = {
    "invoice": "string",
    "applied_date": "2024-01-15T09:30:00Z",
    "applied_amount": "string"
}
headers = {
    "X-Account-Token": "X-Account-Token",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.merge.dev/api/accounting/v1/credit-notes/id/application';
const options = {
  method: 'POST',
  headers: {
    'X-Account-Token': 'X-Account-Token',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"invoice":"string","applied_date":"2024-01-15T09:30:00Z","applied_amount":"string"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.merge.dev/api/accounting/v1/credit-notes/id/application"

	payload := strings.NewReader("{\n  \"invoice\": \"string\",\n  \"applied_date\": \"2024-01-15T09:30:00Z\",\n  \"applied_amount\": \"string\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Account-Token", "X-Account-Token")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.merge.dev/api/accounting/v1/credit-notes/id/application")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Account-Token"] = 'X-Account-Token'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"invoice\": \"string\",\n  \"applied_date\": \"2024-01-15T09:30:00Z\",\n  \"applied_amount\": \"string\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.merge.dev/api/accounting/v1/credit-notes/id/application")
  .header("X-Account-Token", "X-Account-Token")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"invoice\": \"string\",\n  \"applied_date\": \"2024-01-15T09:30:00Z\",\n  \"applied_amount\": \"string\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.merge.dev/api/accounting/v1/credit-notes/id/application', [
  'body' => '{
  "invoice": "string",
  "applied_date": "2024-01-15T09:30:00Z",
  "applied_amount": "string"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
    'X-Account-Token' => 'X-Account-Token',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.merge.dev/api/accounting/v1/credit-notes/id/application");
var request = new RestRequest(Method.POST);
request.AddHeader("X-Account-Token", "X-Account-Token");
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"invoice\": \"string\",\n  \"applied_date\": \"2024-01-15T09:30:00Z\",\n  \"applied_amount\": \"string\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "X-Account-Token": "X-Account-Token",
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "invoice": "string",
  "applied_date": "2024-01-15T09:30:00Z",
  "applied_amount": "string"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.merge.dev/api/accounting/v1/credit-notes/id/application")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```