Create credit note

POST

admin

api

accounts

credit-notes

Create credit note

curl --request POST \
  --url https://erp.arukz.com/admin/api/v1/accounts/credit-notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "partner_id": 1,
  "currency_id": 1,
  "journal_id": 1,
  "invoice_date": "2026-02-16",
  "invoice_lines": [
    {
      "product_id": 1,
      "quantity": 2,
      "uom_id": 1,
      "price_unit": 100,
      "discount": 10,
      "taxes": [
        1,
        2
      ]
    }
  ]
}
'

import requests

url = "https://erp.arukz.com/admin/api/v1/accounts/credit-notes"

payload = {
    "partner_id": 1,
    "currency_id": 1,
    "journal_id": 1,
    "invoice_date": "2026-02-16",
    "invoice_lines": [
        {
            "product_id": 1,
            "quantity": 2,
            "uom_id": 1,
            "price_unit": 100,
            "discount": 10,
            "taxes": [1, 2]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    partner_id: 1,
    currency_id: 1,
    journal_id: 1,
    invoice_date: '2026-02-16',
    invoice_lines: [
      {
        product_id: 1,
        quantity: 2,
        uom_id: 1,
        price_unit: 100,
        discount: 10,
        taxes: [1, 2]
      }
    ]
  })
};

fetch('https://erp.arukz.com/admin/api/v1/accounts/credit-notes', 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://erp.arukz.com/admin/api/v1/accounts/credit-notes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'partner_id' => 1,
    'currency_id' => 1,
    'journal_id' => 1,
    'invoice_date' => '2026-02-16',
    'invoice_lines' => [
        [
                'product_id' => 1,
                'quantity' => 2,
                'uom_id' => 1,
                'price_unit' => 100,
                'discount' => 10,
                'taxes' => [
                                1,
                                2
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "id": 1,
    "sort": 1,
    "journal_id": 2,
    "company_id": 1,
    "campaign_id": null,
    "tax_cash_basis_origin_move_id": null,
    "auto_post_origin_id": null,
    "origin_payment_id": null,
    "secure_sequence_number": null,
    "invoice_payment_term_id": null,
    "partner_id": 41,
    "commercial_partner_id": 41,
    "partner_shipping_id": 41,
    "partner_bank_id": null,
    "fiscal_position_id": null,
    "currency_id": 1,
    "reversed_entry_id": null,
    "invoice_user_id": null,
    "invoice_incoterm_id": null,
    "invoice_cash_rounding_id": null,
    "preferred_payment_method_line_id": null,
    "creator_id": 1,
    "sequence_prefix": "BILL/2026",
    "access_token": null,
    "name": "BILL/2026/1",
    "reference": null,
    "state": "draft",
    "move_type": "in_invoice",
    "auto_post": 0,
    "inalterable_hash": null,
    "payment_reference": null,
    "qr_code_method": null,
    "payment_state": "not_paid",
    "invoice_source_email": null,
    "invoice_partner_display_name": "Eden Hebert -Supplier",
    "invoice_origin": "PO/1",
    "incoterm_location": null,
    "date": "2026-01-08T00:00:00.000000Z",
    "auto_post_until": null,
    "invoice_date": null,
    "invoice_date_due": null,
    "delivery_date": null,
    "sending_data": null,
    "narration": null,
    "invoice_currency_rate": "1.0000",
    "amount_untaxed": "35000.0000",
    "amount_tax": "0.0000",
    "amount_total": "35000.0000",
    "amount_residual": "35000.0000",
    "amount_untaxed_signed": "-35000.0000",
    "amount_untaxed_in_currency_signed": "-35000.0000",
    "amount_tax_signed": "0.0000",
    "amount_total_signed": "-35000.0000",
    "amount_total_in_currency_signed": "-35000.0000",
    "amount_residual_signed": "-35000.0000",
    "quick_edit_total_amount": null,
    "is_storno": 0,
    "always_tax_exigible": 0,
    "checked": false,
    "posted_before": 0,
    "made_sequence_gap": 0,
    "is_manually_modified": 0,
    "is_move_sent": 0,
    "source_id": null,
    "medium_id": null,
    "created_at": "2026-01-08T12:56:46.000000Z",
    "updated_at": "2026-01-08T12:56:47.000000Z"
  },
  "message": "Credit note created successfully."
}

{
  "message": "Unauthenticated."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "partner_id": [
      "The partner id field is required."
    ]
  }
}

Authorizations

Authorization

string

header

required

An API token from Sign in, sent as Authorization: Bearer <token>. Tokens last 30 days.

Body

application/json

partner_id

integer

required

The customer/partner ID. The id of an existing record in the partners_partners table.

Example:

1

currency_id

integer

required

The currency ID. The id of an existing record in the currencies table.

Example:

1

journal_id

integer

required

The journal ID for invoices. The id of an existing record in the accounts_journals table.

Example:

1

invoice_date

string

required

The invoice date. Must be a valid date.

Example:

"2026-02-16"

invoice_lines

object[]

required

Array of invoice line items with product details, quantities, prices, and taxes. Must have at least 1 items.

Show child attributes

Example:

[
  {
    "product_id": 1,
    "quantity": 2,
    "uom_id": 1,
    "price_unit": 100,
    "discount": 10,
    "taxes": [1, 2]
  }
]

invoice_date_due

string | null

The invoice due date. Cannot be provided if invoice_payment_term_id is specified. Must be a valid date.

Example:

"2026-03-16"

invoice_payment_term_id

integer | null

The payment term ID. Cannot be provided if invoice_date_due is specified. The id of an existing record in the accounts_payment_terms table.

Example:

1

fiscal_position_id

integer | null

The fiscal position ID. The id of an existing record in the accounts_fiscal_positions table.

Example:

1

invoice_user_id

integer | null

The salesperson/user ID. The id of an existing record in the users table.

Example:

1

partner_bank_id

integer | null

The recipient bank account ID. The id of an existing record in the partners_bank_accounts table.

Example:

1

invoice_incoterm_id

integer | null

The incoterm ID. The id of an existing record in the accounts_incoterms table.

Example:

1

invoice_cash_rounding_id

integer | null

The cash rounding ID. The id of an existing record in the accounts_cash_roundings table.

Example:

1

preferred_payment_method_line_id

integer | null

The preferred payment method line ID. The id of an existing record in the accounts_payment_method_lines table.

Example:

1

reference

string | null

The customer reference. Must not be greater than 255 characters.

Example:

"INV-2026-001"

payment_reference

string | null

The payment reference. Must not be greater than 255 characters.

Example:

"PAY-001"

narration

string | null

Terms and conditions / Internal notes.

Example:

"Additional information"

incoterm_location

string | null

The incoterm location. Must not be greater than 255 characters.

Example:

"New York"

delivery_date

string | null

The delivery date. Must be a valid date.

Example:

"2026-02-20"

Response

Created

⌘I

Create credit note

curl --request POST \
  --url https://erp.arukz.com/admin/api/v1/accounts/credit-notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "partner_id": 1,
  "currency_id": 1,
  "journal_id": 1,
  "invoice_date": "2026-02-16",
  "invoice_lines": [
    {
      "product_id": 1,
      "quantity": 2,
      "uom_id": 1,
      "price_unit": 100,
      "discount": 10,
      "taxes": [
        1,
        2
      ]
    }
  ]
}
'

import requests

url = "https://erp.arukz.com/admin/api/v1/accounts/credit-notes"

payload = {
    "partner_id": 1,
    "currency_id": 1,
    "journal_id": 1,
    "invoice_date": "2026-02-16",
    "invoice_lines": [
        {
            "product_id": 1,
            "quantity": 2,
            "uom_id": 1,
            "price_unit": 100,
            "discount": 10,
            "taxes": [1, 2]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    partner_id: 1,
    currency_id: 1,
    journal_id: 1,
    invoice_date: '2026-02-16',
    invoice_lines: [
      {
        product_id: 1,
        quantity: 2,
        uom_id: 1,
        price_unit: 100,
        discount: 10,
        taxes: [1, 2]
      }
    ]
  })
};

fetch('https://erp.arukz.com/admin/api/v1/accounts/credit-notes', 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://erp.arukz.com/admin/api/v1/accounts/credit-notes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'partner_id' => 1,
    'currency_id' => 1,
    'journal_id' => 1,
    'invoice_date' => '2026-02-16',
    'invoice_lines' => [
        [
                'product_id' => 1,
                'quantity' => 2,
                'uom_id' => 1,
                'price_unit' => 100,
                'discount' => 10,
                'taxes' => [
                                1,
                                2
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "id": 1,
    "sort": 1,
    "journal_id": 2,
    "company_id": 1,
    "campaign_id": null,
    "tax_cash_basis_origin_move_id": null,
    "auto_post_origin_id": null,
    "origin_payment_id": null,
    "secure_sequence_number": null,
    "invoice_payment_term_id": null,
    "partner_id": 41,
    "commercial_partner_id": 41,
    "partner_shipping_id": 41,
    "partner_bank_id": null,
    "fiscal_position_id": null,
    "currency_id": 1,
    "reversed_entry_id": null,
    "invoice_user_id": null,
    "invoice_incoterm_id": null,
    "invoice_cash_rounding_id": null,
    "preferred_payment_method_line_id": null,
    "creator_id": 1,
    "sequence_prefix": "BILL/2026",
    "access_token": null,
    "name": "BILL/2026/1",
    "reference": null,
    "state": "draft",
    "move_type": "in_invoice",
    "auto_post": 0,
    "inalterable_hash": null,
    "payment_reference": null,
    "qr_code_method": null,
    "payment_state": "not_paid",
    "invoice_source_email": null,
    "invoice_partner_display_name": "Eden Hebert -Supplier",
    "invoice_origin": "PO/1",
    "incoterm_location": null,
    "date": "2026-01-08T00:00:00.000000Z",
    "auto_post_until": null,
    "invoice_date": null,
    "invoice_date_due": null,
    "delivery_date": null,
    "sending_data": null,
    "narration": null,
    "invoice_currency_rate": "1.0000",
    "amount_untaxed": "35000.0000",
    "amount_tax": "0.0000",
    "amount_total": "35000.0000",
    "amount_residual": "35000.0000",
    "amount_untaxed_signed": "-35000.0000",
    "amount_untaxed_in_currency_signed": "-35000.0000",
    "amount_tax_signed": "0.0000",
    "amount_total_signed": "-35000.0000",
    "amount_total_in_currency_signed": "-35000.0000",
    "amount_residual_signed": "-35000.0000",
    "quick_edit_total_amount": null,
    "is_storno": 0,
    "always_tax_exigible": 0,
    "checked": false,
    "posted_before": 0,
    "made_sequence_gap": 0,
    "is_manually_modified": 0,
    "is_move_sent": 0,
    "source_id": null,
    "medium_id": null,
    "created_at": "2026-01-08T12:56:46.000000Z",
    "updated_at": "2026-01-08T12:56:47.000000Z"
  },
  "message": "Credit note created successfully."
}

{
  "message": "Unauthenticated."
}

{
  "message": "The given data was invalid.",
  "errors": {
    "partner_id": [
      "The partner id field is required."
    ]
  }
}

Get started

Endpoints

Authorizations

Body

Response