Partially update bank account

curl --request PATCH \
  --url https://dev.noyax.com/services/noyax_api/api/v1/finance/bank-accounts/{bankAccountId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-CompanyID: <x-companyid>' \
  --header 'X-UserID: <x-userid>' \
  --data '
{
  "BankName": "İŞ BANKASI",
  "Name": "İş Bankası TRY Hesabı",
  "BranchName": "<string>",
  "BranchCode": "<string>",
  "AccountNumber": "<string>",
  "Iban": "<string>",
  "AccountType": 1,
  "CurrencyCode": "TRY",
  "IsDisabled": false,
  "SharingCode": "<string>"
}
'

using RestSharp;


var options = new RestClientOptions("https://dev.noyax.com/services/noyax_api/api/v1/finance/bank-accounts/{bankAccountId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"BankName\": \"İŞ BANKASI\",\n  \"Name\": \"İş Bankası TRY Hesabı\",\n  \"BranchName\": \"<string>\",\n  \"BranchCode\": \"<string>\",\n  \"AccountNumber\": \"<string>\",\n  \"Iban\": \"<string>\",\n  \"AccountType\": 1,\n  \"CurrencyCode\": \"TRY\",\n  \"IsDisabled\": false,\n  \"SharingCode\": \"<string>\"\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'PATCH',
  headers: {
    'X-UserID': '<x-userid>',
    'X-CompanyID': '<x-companyid>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    BankName: 'İŞ BANKASI',
    Name: 'İş Bankası TRY Hesabı',
    BranchName: '<string>',
    BranchCode: '<string>',
    AccountNumber: '<string>',
    Iban: '<string>',
    AccountType: 1,
    CurrencyCode: 'TRY',
    IsDisabled: false,
    SharingCode: '<string>'
  })
};

fetch('https://dev.noyax.com/services/noyax_api/api/v1/finance/bank-accounts/{bankAccountId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://dev.noyax.com/services/noyax_api/api/v1/finance/bank-accounts/{bankAccountId}"

payload = {
    "BankName": "İŞ BANKASI",
    "Name": "İş Bankası TRY Hesabı",
    "BranchName": "<string>",
    "BranchCode": "<string>",
    "AccountNumber": "<string>",
    "Iban": "<string>",
    "AccountType": 1,
    "CurrencyCode": "TRY",
    "IsDisabled": False,
    "SharingCode": "<string>"
}
headers = {
    "X-UserID": "<x-userid>",
    "X-CompanyID": "<x-companyid>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "Success": true,
  "ResultCode": "0000",
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "BankId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "CurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "BankName": "İŞ BANKASI",
    "Name": "İş Bankası TRY Hesabı",
    "BranchName": "<string>",
    "BranchCode": "<string>",
    "AccountNumber": "<string>",
    "Iban": "<string>",
    "AccountType": 1,
    "CurrencyCode": "TRY",
    "IsDisabled": false,
    "SharingCode": "<string>"
  },
  "Message": "<string>"
}

{
  "Success": false,
  "ResultCode": "0201",
  "Message": "X-UserID header is required.",
  "Errors": [
    {
      "Code": "0201",
      "Message": "X-UserID header is required."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0102",
  "Message": "Token has expired. Obtain a new token using the refresh token.",
  "Errors": [
    {
      "Code": "0102",
      "Message": "Token has expired. Obtain a new token using the refresh token."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0110",
  "Message": "You do not have permission for this operation.",
  "Errors": [
    {
      "Code": "0110",
      "Message": "You do not have permission for this operation."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "8010",
  "Message": "Bank account not found.",
  "Errors": [
    {
      "Code": "8010",
      "Message": "Bank account not found."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0120",
  "Message": "Daily request limit (10000) exceeded.",
  "Errors": [
    {
      "Code": "0120",
      "Message": "Daily request limit (10000) exceeded."
    }
  ]
}

PATCH

api

finance

bank-accounts

{bankAccountId}

Partially update bank account

curl --request PATCH \
  --url https://dev.noyax.com/services/noyax_api/api/v1/finance/bank-accounts/{bankAccountId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-CompanyID: <x-companyid>' \
  --header 'X-UserID: <x-userid>' \
  --data '
{
  "BankName": "İŞ BANKASI",
  "Name": "İş Bankası TRY Hesabı",
  "BranchName": "<string>",
  "BranchCode": "<string>",
  "AccountNumber": "<string>",
  "Iban": "<string>",
  "AccountType": 1,
  "CurrencyCode": "TRY",
  "IsDisabled": false,
  "SharingCode": "<string>"
}
'

using RestSharp;


var options = new RestClientOptions("https://dev.noyax.com/services/noyax_api/api/v1/finance/bank-accounts/{bankAccountId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"BankName\": \"İŞ BANKASI\",\n  \"Name\": \"İş Bankası TRY Hesabı\",\n  \"BranchName\": \"<string>\",\n  \"BranchCode\": \"<string>\",\n  \"AccountNumber\": \"<string>\",\n  \"Iban\": \"<string>\",\n  \"AccountType\": 1,\n  \"CurrencyCode\": \"TRY\",\n  \"IsDisabled\": false,\n  \"SharingCode\": \"<string>\"\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'PATCH',
  headers: {
    'X-UserID': '<x-userid>',
    'X-CompanyID': '<x-companyid>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    BankName: 'İŞ BANKASI',
    Name: 'İş Bankası TRY Hesabı',
    BranchName: '<string>',
    BranchCode: '<string>',
    AccountNumber: '<string>',
    Iban: '<string>',
    AccountType: 1,
    CurrencyCode: 'TRY',
    IsDisabled: false,
    SharingCode: '<string>'
  })
};

fetch('https://dev.noyax.com/services/noyax_api/api/v1/finance/bank-accounts/{bankAccountId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://dev.noyax.com/services/noyax_api/api/v1/finance/bank-accounts/{bankAccountId}"

payload = {
    "BankName": "İŞ BANKASI",
    "Name": "İş Bankası TRY Hesabı",
    "BranchName": "<string>",
    "BranchCode": "<string>",
    "AccountNumber": "<string>",
    "Iban": "<string>",
    "AccountType": 1,
    "CurrencyCode": "TRY",
    "IsDisabled": False,
    "SharingCode": "<string>"
}
headers = {
    "X-UserID": "<x-userid>",
    "X-CompanyID": "<x-companyid>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "Success": true,
  "ResultCode": "0000",
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "BankId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "CurrencyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "BankName": "İŞ BANKASI",
    "Name": "İş Bankası TRY Hesabı",
    "BranchName": "<string>",
    "BranchCode": "<string>",
    "AccountNumber": "<string>",
    "Iban": "<string>",
    "AccountType": 1,
    "CurrencyCode": "TRY",
    "IsDisabled": false,
    "SharingCode": "<string>"
  },
  "Message": "<string>"
}

{
  "Success": false,
  "ResultCode": "0201",
  "Message": "X-UserID header is required.",
  "Errors": [
    {
      "Code": "0201",
      "Message": "X-UserID header is required."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0102",
  "Message": "Token has expired. Obtain a new token using the refresh token.",
  "Errors": [
    {
      "Code": "0102",
      "Message": "Token has expired. Obtain a new token using the refresh token."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0110",
  "Message": "You do not have permission for this operation.",
  "Errors": [
    {
      "Code": "0110",
      "Message": "You do not have permission for this operation."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "8010",
  "Message": "Bank account not found.",
  "Errors": [
    {
      "Code": "8010",
      "Message": "Bank account not found."
    }
  ]
}

{
  "Success": false,
  "ResultCode": "0120",
  "Message": "Daily request limit (10000) exceeded.",
  "Errors": [
    {
      "Code": "0120",
      "Message": "Daily request limit (10000) exceeded."
    }
  ]
}

Send only the fields you want to change; fields you do not send keep their current values. Rules and examples: partial update.

A field that is not sent stays unchanged, a field sent as null is cleared.
Validation runs on the whole merged record; setting a required field to null is rejected.

Error codes

Codes this endpoint can return. The general errors that apply to every endpoint (authentication, permissions, request headers, daily limit) are not repeated here.

Code	HTTP	Meaning
`0002`	400	Request body could not be read (malformed JSON, wrong field type)
`0003`	400	A field exceeds its maximum length (the message names the field and the limit)
`0580`	400	A value given as text (a code or a name) matches more than one record; add the detail that tells them apart (for example `City` for a district, `Country` for a city)
`8010`	404	Bank account not found
`8011`	400	Bank account `Name` is required
`8012`	400	`BankName` is required
`8013`	400	`BankName` was not found
`8014`	400	`CurrencyCode` is required
`8015`	400	`CurrencyCode` was not found
`8016`	400	`AccountType` must be between 1 and 4
`8018`	400	`SharingCode` is not one of the user’s sharing codes

Authorizations

Authorization

string

header

required

Access token obtained from the Noyax auth service with your API key.

Headers

X-UserID

integer<int32>

required

ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.

Required range: x >= 1

X-CompanyID

integer<int32>

required

ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.

Required range: x >= 1

X-PeriodID

integer<int32>

ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.

Required range: x >= 1

Path Parameters

bankAccountId

string<uuid>

required

Bank account ID.

Body

BankName

null | string

Required. Bank name from GET /api/v1/finance/banks.

Example:

"İŞ BANKASI"

Name

null | string

Required. Account name, unique within the company. At most 255 characters.

Example:

"İş Bankası TRY Hesabı"

BranchName

null | string

Branch name. At most 50 characters.

BranchCode

null | string

Branch code. At most 10 characters.

AccountNumber

null | string

Account number. At most 20 characters.

Iban

null | string

IBAN. At most 50 characters.

AccountType

integer<int32>

Required. 1: Commercial account, 2: Collateral account, 3: POS account, 4: Credit card account (the company's own credit card).

Example:

1

CurrencyCode

null | string

Required. Currency code from GET /api/v1/definitions/currencies.

Example:

"TRY"

IsDisabled

boolean

Whether the account is disabled (not used for new transactions).

Example:

false

Sharing code that limits who can see the account. Empty means visible to everyone; otherwise it must be one of the user's sharing codes.

Response

Success

boolean

required

Whether the operation succeeded.

Example:

true

ResultCode

string

required

"0000" on success. On failure, the code of the first error; all errors are listed in Errors.

Example:

"0000"

Data

object

required

Show child attributes

Message

null | string

Error message when Success is false. Messages of all errors are joined into a single text.

Getting started

Core concepts

Modules

Release notes

Partially update bank account

Error codes

Authorizations

Headers

Path Parameters

Body

Response

​Error codes

Authorizations

Headers

Path Parameters

Body

Response

Error codes