Update journal

PUT

admin

api

accounts

journals

{id}

Update journal

curl --request PUT \
  --url https://erp.arukz.com/admin/api/v1/accounts/journals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Bank Journal"
}
'

import requests

url = "https://erp.arukz.com/admin/api/v1/accounts/journals/{id}"

payload = { "name": "Bank Journal" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Bank Journal'})
};

fetch('https://erp.arukz.com/admin/api/v1/accounts/journals/{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://erp.arukz.com/admin/api/v1/accounts/journals/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Bank Journal'
  ]),
  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,
    "name": "Customer Invoices",
    "code": "INV",
    "type": "sale",
    "color": "11",
    "sort": 5,
    "show_on_dashboard": 1,
    "refund_order": 1,
    "payment_order": 0,
    "company_id": 1,
    "currency_id": 1,
    "default_account_id": 27,
    "suspense_account_id": null,
    "profit_account_id": null,
    "loss_account_id": null,
    "bank_account_id": null,
    "creator_id": 1,
    "created_at": null,
    "updated_at": null
  },
  "message": "Journal updated successfully."
}

{
  "message": "Unauthenticated."
}

{
  "message": "Resource not found."
}

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

Authorizations

Authorization

string

header

required

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

Path Parameters

integer

required

The journal ID

Example:

1

Body

application/json

name

string

Journal name. Must not be greater than 255 characters.

Example:

"Bank Journal"

code

string

Journal code (max 5 chars). Must not be greater than 5 characters.

Example:

"BNK"

type

enum<string>

Journal type.

Available options:

sale,

purchase,

cash,

bank,

credit,

general

Example:

"bank"

company_id

integer | null

Company ID. The id of an existing record in the companies table.

Example:

1

currency_id

integer | null

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

Example:

1

default_account_id

integer | null

Default account ID. The id of an existing record in the accounts_accounts table.

Example:

1

suspense_account_id

integer | null

Suspense account ID. The id of an existing record in the accounts_accounts table.

Example:

2

profit_account_id

integer | null

Profit account ID. The id of an existing record in the accounts_accounts table.

Example:

3

loss_account_id

integer | null

Loss account ID. The id of an existing record in the accounts_accounts table.

Example:

4

bank_account_id

integer | null

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

Example:

1

color

string | null

Journal color (hex). Must not be greater than 7 characters.

Example:

"#3b82f6"

show_on_dashboard

boolean | null

Show on dashboard.

Example:

false

refund_order

boolean | null

Refund order flag.

Example:

false

payment_order

boolean | null

Payment order flag.

Example:

false

inbound_payment_method_lines

object[] | null

Inbound payment method lines (for BANK, CASH, CREDIT_CARD journals). Include id for update, omit for create.

Show child attributes

Example:

[
  {
    "payment_method_id": 1,
    "name": "Manual",
    "payment_account_id": 5
  }
]

outbound_payment_method_lines

object[] | null

Outbound payment method lines (for BANK, CASH, CREDIT_CARD journals). Include id for update, omit for create.

Show child attributes

Example:

[
  {
    "payment_method_id": 2,
    "name": "Electronic",
    "payment_account_id": 6
  }
]

Response

Success

⌘I

Update journal

curl --request PUT \
  --url https://erp.arukz.com/admin/api/v1/accounts/journals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Bank Journal"
}
'

import requests

url = "https://erp.arukz.com/admin/api/v1/accounts/journals/{id}"

payload = { "name": "Bank Journal" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Bank Journal'})
};

fetch('https://erp.arukz.com/admin/api/v1/accounts/journals/{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://erp.arukz.com/admin/api/v1/accounts/journals/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Bank Journal'
  ]),
  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,
    "name": "Customer Invoices",
    "code": "INV",
    "type": "sale",
    "color": "11",
    "sort": 5,
    "show_on_dashboard": 1,
    "refund_order": 1,
    "payment_order": 0,
    "company_id": 1,
    "currency_id": 1,
    "default_account_id": 27,
    "suspense_account_id": null,
    "profit_account_id": null,
    "loss_account_id": null,
    "bank_account_id": null,
    "creator_id": 1,
    "created_at": null,
    "updated_at": null
  },
  "message": "Journal updated successfully."
}

{
  "message": "Unauthenticated."
}

{
  "message": "Resource not found."
}

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

Get started

Endpoints

Authorizations

Path Parameters

Body

Response