Skip to main content
POST
Create Credit Memo

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Body

lines
object[]
required
credit_memo_date
string<date>
required
entity
integer
required
credit_memo_number
string
migrated_journal_id
integer | null
write-only
chat_uuid
string<uuid>
write-only
credit_memo_type
enum<string>
  • credit_memo - Credit Memo
  • overpayment - Overpayment
Available options:
credit_memo,
overpayment
ref_number
string | null
Maximum string 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 string length: 3
exchange_rate
number<double> | null
Required range: -100000000000000 < x < 100000000000000
exchange_rate_book
number<double> | null
Required range: -100000000000000 < x < 100000000000000
last_sent_at
string<date-time> | null
anrok_transaction_id
string | null

ID of the negation transaction in Anrok for this credit memo

Maximum string length: 255
integration_id
string | null
Maximum string length: 250
integration_context
unknown
vat_number
string | null
Maximum string length: 250
total_amount
number<double>

Sum of all line item amounts

Required range: -1000000000000000000 < x < 1000000000000000000
amount_used
number<double>

Sum of all non-voided payment amounts

Required range: -1000000000000000000 < x < 1000000000000000000
chat_id
integer | null
Required range: -2147483648 <= x <= 2147483647
client
integer | null
credit_account
integer | null
journal_entry
integer | null
contract
integer | null
voided_journal_entry
integer | null
anrok_connection
integer | null
avalara_connection
integer | null
sphere_connection
integer | null

Response

201 - application/json
id
integer
required
read-only
lines
object[]
required
payments
object[]
required
read-only
amount_remaining
number<double>
required
read-only

Calculate amount remaining from database fields

entity_name
string
required
read-only
entity_currency
string
required
read-only
client_name
string
required
read-only
client_email
string
required
read-only
contract_name
string
required
read-only
credit_account_number
string
required
read-only
credit_account_name
string | null
required
read-only

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

attachments
object[]
required
read-only
voided_date
string<date>
required
read-only
voided_journal_entry_order
string
required
read-only
last_modified_at
string<date-time>
required
read-only
is_deleted
boolean
default:false
required
read-only
deleted_at
string<date-time> | null
required
read-only
search_vector
string | null
required
read-only
search_text
string | null
required
read-only
credit_memo_date
string<date>
required
created_at
string<date-time>
required
read-only
customer
integer
required
read-only
entity
integer
required
credit_memo_number
string
credit_memo_type
enum<string>
  • credit_memo - Credit Memo
  • overpayment - Overpayment
Available options:
credit_memo,
overpayment
ref_number
string | null
Maximum string 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 string length: 3
exchange_rate
number<double> | null
Required range: -100000000000000 < x < 100000000000000
exchange_rate_book
number<double> | null
Required range: -100000000000000 < x < 100000000000000
last_sent_at
string<date-time> | null
anrok_transaction_id
string | null

ID of the negation transaction in Anrok for this credit memo

Maximum string length: 255
integration_id
string | null
Maximum string length: 250
integration_context
unknown
vat_number
string | null
Maximum string length: 250
total_amount
number<double>

Sum of all line item amounts

Required range: -1000000000000000000 < x < 1000000000000000000
amount_used
number<double>

Sum of all non-voided payment amounts

Required range: -1000000000000000000 < x < 1000000000000000000
chat_id
integer | null
Required range: -2147483648 <= x <= 2147483647
client
integer | null
credit_account
integer | null
journal_entry
integer | null
contract
integer | null
voided_journal_entry
integer | null
anrok_connection
integer | null
avalara_connection
integer | null
sphere_connection
integer | null