Skip to main content
PATCH
/
coa
/
api
/
v1
/
credit-memo
/
{id}
curl --request PATCH \
--url https://api.meetcampfire.com/coa/api/v1/credit-memo/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"amount": "750.00",
"internal_message": "Adjusted credit amount per client request - approval #CM-2024-456"
}'
{
  "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"
}

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
integer
required

Body

lines
object[]
credit_memo_number
string
migrated_journal_id
integer | null
ref_number
string | null
Maximum length: 120
credit_memo_date
string<date>
applied_date
string<date> | null
message_on_credit_memo
string | null
application_status
  • open - Open
  • partially_used - Partially Used
  • used - Used
  • voided - Voided
Available options:
open,
partially_used,
used,
voided
currency
string
Maximum length: 3
exchange_rate
number | null
Required range: -100000000000000 < x < 100000000000000
exchange_rate_book
number | null
Required range: -100000000000000 < x < 100000000000000
entity
integer
client
integer | null
credit_account
integer | null
journal_entry
integer | null
contract
integer | null
voided_journal_entry
integer | null

Response

200 - application/json
id
integer
required
lines
object[]
required
payments
object[]
required
total_amount
string
required
amount_used
string
required
amount_remaining
string
required
entity_name
string
required
entity_currency
string
required
client_name
string
required
contract_name
string
required
credit_account_number
string
required
credit_account_name
string
required

Combines account number and name in the format "number - name"

attachments
object[]
required
voided_date
string<date>
required
voided_journal_entry_order
string
required
last_modified_at
string<date-time>
required
is_deleted
boolean
default:false
required
deleted_at
string<date-time> | null
required
credit_memo_date
string<date>
required
created_at
string<date-time>
required
customer
integer
required
entity
integer
required
credit_memo_number
string
ref_number
string | null
Maximum length: 120
applied_date
string<date> | null
message_on_credit_memo
string | null
application_status
  • open - Open
  • partially_used - Partially Used
  • used - Used
  • voided - Voided
Available options:
open,
partially_used,
used,
voided
currency
string
Maximum length: 3
exchange_rate
number | null
Required range: -100000000000000 < x < 100000000000000
exchange_rate_book
number | null
Required range: -100000000000000 < x < 100000000000000
client
integer | null
credit_account
integer | null
journal_entry
integer | null
contract
integer | null
voided_journal_entry
integer | null
I