Partial Update Credit Memo
curl --request PATCH \
--url https://api.meetcampfire.com/coa/api/v1/credit-memo/{id} \
--header 'Content-Type: application/json' \
--data '
{
"lines": [
{
"account": 123,
"credit_memo": 123,
"description": "<string>",
"amount": 0,
"tax": 0,
"tax_description": "<string>",
"tag_ids": [
0
],
"tag_group_ids": [
0
],
"product": 123,
"tax_rate": 123,
"department": 123
}
],
"revenue_contract": 123,
"credit_memo_number": "<string>",
"migrated_journal_id": 123,
"chat_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref_number": "<string>",
"credit_memo_date": "2023-12-25",
"applied_date": "2023-12-25",
"message_on_credit_memo": "<string>",
"currency": "<string>",
"exchange_rate": 0,
"exchange_rate_book": 0,
"last_sent_at": "2023-11-07T05:31:56Z",
"anrok_transaction_id": "<string>",
"integration_id": "<string>",
"integration_context": null,
"vat_number": "<string>",
"total_amount": 0,
"amount_used": 0,
"chat_id": -1,
"entity": 123,
"client": 123,
"credit_account": 123,
"journal_entry": 123,
"contract": 123,
"voided_journal_entry": 123,
"anrok_connection": 123,
"avalara_connection": 123,
"sphere_connection": 123
}
'import requests
url = "https://api.meetcampfire.com/coa/api/v1/credit-memo/{id}"
payload = {
"lines": [
{
"account": 123,
"credit_memo": 123,
"description": "<string>",
"amount": 0,
"tax": 0,
"tax_description": "<string>",
"tag_ids": [0],
"tag_group_ids": [0],
"product": 123,
"tax_rate": 123,
"department": 123
}
],
"revenue_contract": 123,
"credit_memo_number": "<string>",
"migrated_journal_id": 123,
"chat_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref_number": "<string>",
"credit_memo_date": "2023-12-25",
"applied_date": "2023-12-25",
"message_on_credit_memo": "<string>",
"currency": "<string>",
"exchange_rate": 0,
"exchange_rate_book": 0,
"last_sent_at": "2023-11-07T05:31:56Z",
"anrok_transaction_id": "<string>",
"integration_id": "<string>",
"integration_context": None,
"vat_number": "<string>",
"total_amount": 0,
"amount_used": 0,
"chat_id": -1,
"entity": 123,
"client": 123,
"credit_account": 123,
"journal_entry": 123,
"contract": 123,
"voided_journal_entry": 123,
"anrok_connection": 123,
"avalara_connection": 123,
"sphere_connection": 123
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
lines: [
{
account: 123,
credit_memo: 123,
description: '<string>',
amount: 0,
tax: 0,
tax_description: '<string>',
tag_ids: [0],
tag_group_ids: [0],
product: 123,
tax_rate: 123,
department: 123
}
],
revenue_contract: 123,
credit_memo_number: '<string>',
migrated_journal_id: 123,
chat_uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
ref_number: '<string>',
credit_memo_date: '2023-12-25',
applied_date: '2023-12-25',
message_on_credit_memo: '<string>',
currency: '<string>',
exchange_rate: 0,
exchange_rate_book: 0,
last_sent_at: '2023-11-07T05:31:56Z',
anrok_transaction_id: '<string>',
integration_id: '<string>',
integration_context: null,
vat_number: '<string>',
total_amount: 0,
amount_used: 0,
chat_id: -1,
entity: 123,
client: 123,
credit_account: 123,
journal_entry: 123,
contract: 123,
voided_journal_entry: 123,
anrok_connection: 123,
avalara_connection: 123,
sphere_connection: 123
})
};
fetch('https://api.meetcampfire.com/coa/api/v1/credit-memo/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.meetcampfire.com/coa/api/v1/credit-memo/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'lines' => [
[
'account' => 123,
'credit_memo' => 123,
'description' => '<string>',
'amount' => 0,
'tax' => 0,
'tax_description' => '<string>',
'tag_ids' => [
0
],
'tag_group_ids' => [
0
],
'product' => 123,
'tax_rate' => 123,
'department' => 123
]
],
'revenue_contract' => 123,
'credit_memo_number' => '<string>',
'migrated_journal_id' => 123,
'chat_uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'ref_number' => '<string>',
'credit_memo_date' => '2023-12-25',
'applied_date' => '2023-12-25',
'message_on_credit_memo' => '<string>',
'currency' => '<string>',
'exchange_rate' => 0,
'exchange_rate_book' => 0,
'last_sent_at' => '2023-11-07T05:31:56Z',
'anrok_transaction_id' => '<string>',
'integration_id' => '<string>',
'integration_context' => null,
'vat_number' => '<string>',
'total_amount' => 0,
'amount_used' => 0,
'chat_id' => -1,
'entity' => 123,
'client' => 123,
'credit_account' => 123,
'journal_entry' => 123,
'contract' => 123,
'voided_journal_entry' => 123,
'anrok_connection' => 123,
'avalara_connection' => 123,
'sphere_connection' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.meetcampfire.com/coa/api/v1/credit-memo/{id}"
payload := strings.NewReader("{\n \"lines\": [\n {\n \"account\": 123,\n \"credit_memo\": 123,\n \"description\": \"<string>\",\n \"amount\": 0,\n \"tax\": 0,\n \"tax_description\": \"<string>\",\n \"tag_ids\": [\n 0\n ],\n \"tag_group_ids\": [\n 0\n ],\n \"product\": 123,\n \"tax_rate\": 123,\n \"department\": 123\n }\n ],\n \"revenue_contract\": 123,\n \"credit_memo_number\": \"<string>\",\n \"migrated_journal_id\": 123,\n \"chat_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ref_number\": \"<string>\",\n \"credit_memo_date\": \"2023-12-25\",\n \"applied_date\": \"2023-12-25\",\n \"message_on_credit_memo\": \"<string>\",\n \"currency\": \"<string>\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"last_sent_at\": \"2023-11-07T05:31:56Z\",\n \"anrok_transaction_id\": \"<string>\",\n \"integration_id\": \"<string>\",\n \"integration_context\": null,\n \"vat_number\": \"<string>\",\n \"total_amount\": 0,\n \"amount_used\": 0,\n \"chat_id\": -1,\n \"entity\": 123,\n \"client\": 123,\n \"credit_account\": 123,\n \"journal_entry\": 123,\n \"contract\": 123,\n \"voided_journal_entry\": 123,\n \"anrok_connection\": 123,\n \"avalara_connection\": 123,\n \"sphere_connection\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.meetcampfire.com/coa/api/v1/credit-memo/{id}")
.header("Content-Type", "application/json")
.body("{\n \"lines\": [\n {\n \"account\": 123,\n \"credit_memo\": 123,\n \"description\": \"<string>\",\n \"amount\": 0,\n \"tax\": 0,\n \"tax_description\": \"<string>\",\n \"tag_ids\": [\n 0\n ],\n \"tag_group_ids\": [\n 0\n ],\n \"product\": 123,\n \"tax_rate\": 123,\n \"department\": 123\n }\n ],\n \"revenue_contract\": 123,\n \"credit_memo_number\": \"<string>\",\n \"migrated_journal_id\": 123,\n \"chat_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ref_number\": \"<string>\",\n \"credit_memo_date\": \"2023-12-25\",\n \"applied_date\": \"2023-12-25\",\n \"message_on_credit_memo\": \"<string>\",\n \"currency\": \"<string>\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"last_sent_at\": \"2023-11-07T05:31:56Z\",\n \"anrok_transaction_id\": \"<string>\",\n \"integration_id\": \"<string>\",\n \"integration_context\": null,\n \"vat_number\": \"<string>\",\n \"total_amount\": 0,\n \"amount_used\": 0,\n \"chat_id\": -1,\n \"entity\": 123,\n \"client\": 123,\n \"credit_account\": 123,\n \"journal_entry\": 123,\n \"contract\": 123,\n \"voided_journal_entry\": 123,\n \"anrok_connection\": 123,\n \"avalara_connection\": 123,\n \"sphere_connection\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.meetcampfire.com/coa/api/v1/credit-memo/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"lines\": [\n {\n \"account\": 123,\n \"credit_memo\": 123,\n \"description\": \"<string>\",\n \"amount\": 0,\n \"tax\": 0,\n \"tax_description\": \"<string>\",\n \"tag_ids\": [\n 0\n ],\n \"tag_group_ids\": [\n 0\n ],\n \"product\": 123,\n \"tax_rate\": 123,\n \"department\": 123\n }\n ],\n \"revenue_contract\": 123,\n \"credit_memo_number\": \"<string>\",\n \"migrated_journal_id\": 123,\n \"chat_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ref_number\": \"<string>\",\n \"credit_memo_date\": \"2023-12-25\",\n \"applied_date\": \"2023-12-25\",\n \"message_on_credit_memo\": \"<string>\",\n \"currency\": \"<string>\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"last_sent_at\": \"2023-11-07T05:31:56Z\",\n \"anrok_transaction_id\": \"<string>\",\n \"integration_id\": \"<string>\",\n \"integration_context\": null,\n \"vat_number\": \"<string>\",\n \"total_amount\": 0,\n \"amount_used\": 0,\n \"chat_id\": -1,\n \"entity\": 123,\n \"client\": 123,\n \"credit_account\": 123,\n \"journal_entry\": 123,\n \"contract\": 123,\n \"voided_journal_entry\": 123,\n \"anrok_connection\": 123,\n \"avalara_connection\": 123,\n \"sphere_connection\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "9a4bc225-ebe6-41fa-9a2f-de7947899c6c",
"number": "CM-2024-001",
"date": "2024-03-15",
"amount": "750.00",
"currency": "USD",
"exchange_rate": "1.0000",
"amount_used": "0.00",
"amount_available": "750.00",
"status": "open",
"client": {
"id": "client-uuid-123",
"name": "Acme Corporation",
"currency": "USD"
},
"entity": {
"id": "entity-uuid-456",
"name": "Tech Solutions LLC"
},
"internal_message": "Adjusted credit amount per client request - approval #CM-2024-456",
"client_message": "Credit for overpayment on Invoice #INV-2024-001",
"line_items": [
{
"id": "line-item-uuid-789",
"account": {
"id": "account-uuid-revenue",
"name": "Revenue - Software Licenses",
"code": "4001"
},
"description": "Credit for software license overpayment",
"amount": "750.00",
"department": {
"id": "dept-uuid-sales",
"name": "Sales Department"
},
"product": {
"id": "product-uuid-license",
"name": "Enterprise License"
}
}
],
"applied_payments": [],
"tags": [
"overpayment",
"software-license"
],
"contract": null,
"created_at": "2024-03-15T10:30:00Z",
"updated_at": "2024-03-16T14:22:00Z"
}Accounts Receivable
Partial Update Credit Memo
Performs a partial update of an existing accounting credit memo using PATCH semantics.
This endpoint allows selective modification of credit memo fields without requiring a complete credit memo replacement. You can update specific aspects of the credit memo while leaving other fields unchanged.
Updatable Fields:
- Credit memo metadata (dates, messages, descriptions, client, entity, currency)
- Line items (amounts, accounts, descriptions, departments, products)
- Reference numbers and contract associations
- Exchange rates and currency information
- Custom fields and additional metadata
- Application status and tracking information
PATCH
/
coa
/
api
/
v1
/
credit-memo
/
{id}
Partial Update Credit Memo
curl --request PATCH \
--url https://api.meetcampfire.com/coa/api/v1/credit-memo/{id} \
--header 'Content-Type: application/json' \
--data '
{
"lines": [
{
"account": 123,
"credit_memo": 123,
"description": "<string>",
"amount": 0,
"tax": 0,
"tax_description": "<string>",
"tag_ids": [
0
],
"tag_group_ids": [
0
],
"product": 123,
"tax_rate": 123,
"department": 123
}
],
"revenue_contract": 123,
"credit_memo_number": "<string>",
"migrated_journal_id": 123,
"chat_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref_number": "<string>",
"credit_memo_date": "2023-12-25",
"applied_date": "2023-12-25",
"message_on_credit_memo": "<string>",
"currency": "<string>",
"exchange_rate": 0,
"exchange_rate_book": 0,
"last_sent_at": "2023-11-07T05:31:56Z",
"anrok_transaction_id": "<string>",
"integration_id": "<string>",
"integration_context": null,
"vat_number": "<string>",
"total_amount": 0,
"amount_used": 0,
"chat_id": -1,
"entity": 123,
"client": 123,
"credit_account": 123,
"journal_entry": 123,
"contract": 123,
"voided_journal_entry": 123,
"anrok_connection": 123,
"avalara_connection": 123,
"sphere_connection": 123
}
'import requests
url = "https://api.meetcampfire.com/coa/api/v1/credit-memo/{id}"
payload = {
"lines": [
{
"account": 123,
"credit_memo": 123,
"description": "<string>",
"amount": 0,
"tax": 0,
"tax_description": "<string>",
"tag_ids": [0],
"tag_group_ids": [0],
"product": 123,
"tax_rate": 123,
"department": 123
}
],
"revenue_contract": 123,
"credit_memo_number": "<string>",
"migrated_journal_id": 123,
"chat_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref_number": "<string>",
"credit_memo_date": "2023-12-25",
"applied_date": "2023-12-25",
"message_on_credit_memo": "<string>",
"currency": "<string>",
"exchange_rate": 0,
"exchange_rate_book": 0,
"last_sent_at": "2023-11-07T05:31:56Z",
"anrok_transaction_id": "<string>",
"integration_id": "<string>",
"integration_context": None,
"vat_number": "<string>",
"total_amount": 0,
"amount_used": 0,
"chat_id": -1,
"entity": 123,
"client": 123,
"credit_account": 123,
"journal_entry": 123,
"contract": 123,
"voided_journal_entry": 123,
"anrok_connection": 123,
"avalara_connection": 123,
"sphere_connection": 123
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
lines: [
{
account: 123,
credit_memo: 123,
description: '<string>',
amount: 0,
tax: 0,
tax_description: '<string>',
tag_ids: [0],
tag_group_ids: [0],
product: 123,
tax_rate: 123,
department: 123
}
],
revenue_contract: 123,
credit_memo_number: '<string>',
migrated_journal_id: 123,
chat_uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
ref_number: '<string>',
credit_memo_date: '2023-12-25',
applied_date: '2023-12-25',
message_on_credit_memo: '<string>',
currency: '<string>',
exchange_rate: 0,
exchange_rate_book: 0,
last_sent_at: '2023-11-07T05:31:56Z',
anrok_transaction_id: '<string>',
integration_id: '<string>',
integration_context: null,
vat_number: '<string>',
total_amount: 0,
amount_used: 0,
chat_id: -1,
entity: 123,
client: 123,
credit_account: 123,
journal_entry: 123,
contract: 123,
voided_journal_entry: 123,
anrok_connection: 123,
avalara_connection: 123,
sphere_connection: 123
})
};
fetch('https://api.meetcampfire.com/coa/api/v1/credit-memo/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.meetcampfire.com/coa/api/v1/credit-memo/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'lines' => [
[
'account' => 123,
'credit_memo' => 123,
'description' => '<string>',
'amount' => 0,
'tax' => 0,
'tax_description' => '<string>',
'tag_ids' => [
0
],
'tag_group_ids' => [
0
],
'product' => 123,
'tax_rate' => 123,
'department' => 123
]
],
'revenue_contract' => 123,
'credit_memo_number' => '<string>',
'migrated_journal_id' => 123,
'chat_uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'ref_number' => '<string>',
'credit_memo_date' => '2023-12-25',
'applied_date' => '2023-12-25',
'message_on_credit_memo' => '<string>',
'currency' => '<string>',
'exchange_rate' => 0,
'exchange_rate_book' => 0,
'last_sent_at' => '2023-11-07T05:31:56Z',
'anrok_transaction_id' => '<string>',
'integration_id' => '<string>',
'integration_context' => null,
'vat_number' => '<string>',
'total_amount' => 0,
'amount_used' => 0,
'chat_id' => -1,
'entity' => 123,
'client' => 123,
'credit_account' => 123,
'journal_entry' => 123,
'contract' => 123,
'voided_journal_entry' => 123,
'anrok_connection' => 123,
'avalara_connection' => 123,
'sphere_connection' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.meetcampfire.com/coa/api/v1/credit-memo/{id}"
payload := strings.NewReader("{\n \"lines\": [\n {\n \"account\": 123,\n \"credit_memo\": 123,\n \"description\": \"<string>\",\n \"amount\": 0,\n \"tax\": 0,\n \"tax_description\": \"<string>\",\n \"tag_ids\": [\n 0\n ],\n \"tag_group_ids\": [\n 0\n ],\n \"product\": 123,\n \"tax_rate\": 123,\n \"department\": 123\n }\n ],\n \"revenue_contract\": 123,\n \"credit_memo_number\": \"<string>\",\n \"migrated_journal_id\": 123,\n \"chat_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ref_number\": \"<string>\",\n \"credit_memo_date\": \"2023-12-25\",\n \"applied_date\": \"2023-12-25\",\n \"message_on_credit_memo\": \"<string>\",\n \"currency\": \"<string>\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"last_sent_at\": \"2023-11-07T05:31:56Z\",\n \"anrok_transaction_id\": \"<string>\",\n \"integration_id\": \"<string>\",\n \"integration_context\": null,\n \"vat_number\": \"<string>\",\n \"total_amount\": 0,\n \"amount_used\": 0,\n \"chat_id\": -1,\n \"entity\": 123,\n \"client\": 123,\n \"credit_account\": 123,\n \"journal_entry\": 123,\n \"contract\": 123,\n \"voided_journal_entry\": 123,\n \"anrok_connection\": 123,\n \"avalara_connection\": 123,\n \"sphere_connection\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.meetcampfire.com/coa/api/v1/credit-memo/{id}")
.header("Content-Type", "application/json")
.body("{\n \"lines\": [\n {\n \"account\": 123,\n \"credit_memo\": 123,\n \"description\": \"<string>\",\n \"amount\": 0,\n \"tax\": 0,\n \"tax_description\": \"<string>\",\n \"tag_ids\": [\n 0\n ],\n \"tag_group_ids\": [\n 0\n ],\n \"product\": 123,\n \"tax_rate\": 123,\n \"department\": 123\n }\n ],\n \"revenue_contract\": 123,\n \"credit_memo_number\": \"<string>\",\n \"migrated_journal_id\": 123,\n \"chat_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ref_number\": \"<string>\",\n \"credit_memo_date\": \"2023-12-25\",\n \"applied_date\": \"2023-12-25\",\n \"message_on_credit_memo\": \"<string>\",\n \"currency\": \"<string>\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"last_sent_at\": \"2023-11-07T05:31:56Z\",\n \"anrok_transaction_id\": \"<string>\",\n \"integration_id\": \"<string>\",\n \"integration_context\": null,\n \"vat_number\": \"<string>\",\n \"total_amount\": 0,\n \"amount_used\": 0,\n \"chat_id\": -1,\n \"entity\": 123,\n \"client\": 123,\n \"credit_account\": 123,\n \"journal_entry\": 123,\n \"contract\": 123,\n \"voided_journal_entry\": 123,\n \"anrok_connection\": 123,\n \"avalara_connection\": 123,\n \"sphere_connection\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.meetcampfire.com/coa/api/v1/credit-memo/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"lines\": [\n {\n \"account\": 123,\n \"credit_memo\": 123,\n \"description\": \"<string>\",\n \"amount\": 0,\n \"tax\": 0,\n \"tax_description\": \"<string>\",\n \"tag_ids\": [\n 0\n ],\n \"tag_group_ids\": [\n 0\n ],\n \"product\": 123,\n \"tax_rate\": 123,\n \"department\": 123\n }\n ],\n \"revenue_contract\": 123,\n \"credit_memo_number\": \"<string>\",\n \"migrated_journal_id\": 123,\n \"chat_uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"ref_number\": \"<string>\",\n \"credit_memo_date\": \"2023-12-25\",\n \"applied_date\": \"2023-12-25\",\n \"message_on_credit_memo\": \"<string>\",\n \"currency\": \"<string>\",\n \"exchange_rate\": 0,\n \"exchange_rate_book\": 0,\n \"last_sent_at\": \"2023-11-07T05:31:56Z\",\n \"anrok_transaction_id\": \"<string>\",\n \"integration_id\": \"<string>\",\n \"integration_context\": null,\n \"vat_number\": \"<string>\",\n \"total_amount\": 0,\n \"amount_used\": 0,\n \"chat_id\": -1,\n \"entity\": 123,\n \"client\": 123,\n \"credit_account\": 123,\n \"journal_entry\": 123,\n \"contract\": 123,\n \"voided_journal_entry\": 123,\n \"anrok_connection\": 123,\n \"avalara_connection\": 123,\n \"sphere_connection\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "9a4bc225-ebe6-41fa-9a2f-de7947899c6c",
"number": "CM-2024-001",
"date": "2024-03-15",
"amount": "750.00",
"currency": "USD",
"exchange_rate": "1.0000",
"amount_used": "0.00",
"amount_available": "750.00",
"status": "open",
"client": {
"id": "client-uuid-123",
"name": "Acme Corporation",
"currency": "USD"
},
"entity": {
"id": "entity-uuid-456",
"name": "Tech Solutions LLC"
},
"internal_message": "Adjusted credit amount per client request - approval #CM-2024-456",
"client_message": "Credit for overpayment on Invoice #INV-2024-001",
"line_items": [
{
"id": "line-item-uuid-789",
"account": {
"id": "account-uuid-revenue",
"name": "Revenue - Software Licenses",
"code": "4001"
},
"description": "Credit for software license overpayment",
"amount": "750.00",
"department": {
"id": "dept-uuid-sales",
"name": "Sales Department"
},
"product": {
"id": "product-uuid-license",
"name": "Enterprise License"
}
}
],
"applied_payments": [],
"tags": [
"overpayment",
"software-license"
],
"contract": null,
"created_at": "2024-03-15T10:30:00Z",
"updated_at": "2024-03-16T14:22:00Z"
}Path Parameters
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Show child attributes
Show child attributes
Revenue contract to link this credit memo to at creation.
credit_memo- Credit Memooverpayment- Overpayment
Available options:
credit_memo, overpayment Maximum string length:
120open- Openpartially_used- Partially Usedused- Usedvoided- Voided
Available options:
open, partially_used, used, voided Maximum string length:
3Required range:
-100000000000000 < x < 100000000000000Required range:
-100000000000000 < x < 100000000000000ID of the negation transaction in Anrok for this credit memo
Maximum string length:
255Maximum string length:
250Maximum string length:
250Sum of all line item amounts
Required range:
-1000000000000000000 < x < 1000000000000000000Sum of all non-voided payment amounts
Required range:
-1000000000000000000 < x < 1000000000000000000Required range:
-2147483648 <= x <= 2147483647Response
200 - application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Calculate amount remaining from database fields
Combines account number and name in the format "number - name"
Show child attributes
Show child attributes
Revenue contract to link this credit memo to at creation.
credit_memo- Credit Memooverpayment- Overpayment
Available options:
credit_memo, overpayment Maximum string length:
120open- Openpartially_used- Partially Usedused- Usedvoided- Voided
Available options:
open, partially_used, used, voided Maximum string length:
3Required range:
-100000000000000 < x < 100000000000000Required range:
-100000000000000 < x < 100000000000000ID of the negation transaction in Anrok for this credit memo
Maximum string length:
255Maximum string length:
250Maximum string length:
250Sum of all line item amounts
Required range:
-1000000000000000000 < x < 1000000000000000000Sum of all non-voided payment amounts
Required range:
-1000000000000000000 < x < 1000000000000000000Required range:
-2147483648 <= x <= 2147483647