CreditNotes
Get Credit Note
Get Credit Note by id
get/credit-notes/{id}
Path parameters
idinteger required
Response
Successful operation
Example response
{
"message": "success.",
"credit_note": {
"id": 287,
"account": {
"id": 403,
"organization_id": "0005",
"name": "Lexzur KSA",
"account_label": "Lexzur KSA (SAR)",
"account_data": "Lexzur KSA",
"system_account": "no",
"account_type_id": 15,
"account_type": "Third Party",
"number": "1",
"currency_id": 194,
"currency": "SAR",
"model_id": 24,
"member_id": 4,
"model_name": "Person",
"model_type": "client",
"organization": {
"id": "0005",
"name": "zatca",
"country": "SA",
"city": "Riyadh",
"state": "Riyadh",
"zip": "1000"
},
"client": {
"id": "00000024",
"discount_percentage": "0.000",
"member_label": "PER00000004"
}
},
"credit_note_number": "DRFT0000001",
"prefix_type": 1,
"prefix": "DRFT",
"reference_number": "0000001",
"bill_to": "Lexzur KSA",
"credit_note_date": "2024-11-06 00:00:00",
"paid_status": "draft",
"display_discount": "no",
"display_item_quantity": 1,
"credit_note_reason_id": 1,
"term_id": 1,
"terms": "In Advance",
"lines_total_subtotal": 250,
"lines_totals": 250,
"total": 275,
"invoices_closed": 275,
"exchange_rate": 1,
"display_adjust": "invoice_level_after_tax",
"adjust_percentage": 10,
"adjust_amount": 25,
"adjust_value_type": "percentage",
"created_on": "2024-11-06 13:59:06",
"created_by_name": "System Administrator",
"modified_on": "2024-11-06 13:59:06",
"modified_by_name": "System Administrator",
"invoices_close": 275,
"sub_total": 250,
"non_taxable": 250,
"sub_total_after_discount": 250,
"services_subtotal": 250,
"related_invoices": [
{
"id": 140,
"credit_note_header_id": 287,
"invoice_header_id": 277,
"voucher_header_id": 765,
"total": 275,
"invoice_date": "2024-11-06 00:00:00",
"invoice_total": 500,
"paid_status": "open",
"invoice_number": "INV0000001",
"balance_due": 500
}
],
"credit_note_details": [
{
"id": 212,
"account_id": 384,
"item_id": 22,
"item_title": "Incorporation",
"unit_price": 250,
"quantity": 1,
"discount_type": "percentage",
"line_sub_total": 250,
"sub_total_after_line_disc": 250,
"total": 250,
"item_date": "2024-11-06"
}
],
"e_invoicing_key": "saudi",
"credit_note_type_id": 1,
"transaction_type_id": 1
}
}