Skip to content

patchChartAccount

Request

Path
idinteger, (int32)required
Bodyapplication/jsonrequired
property name*anyadditional property
PATCH
/api/v1/accounting-chart-account/{id}
curl -i -X PATCH \
  'https://api.prana.software/api/v1/accounting-chart-account/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "property1": null,
    "property2": null
  }'

Responses

OK

Bodyapplication/json
idinteger, (int32)required

Unique identifier of the object

Default:""
codestring

Code of the chart account

Default:""
Example:"4300000001"
descriptionstring

Description of the chart account

Default:""
Example:"Clientes"
activeboolean

Indicates if the account is active

Default:false
Example:true
colorstring

Color code for visual representation

Default:""
Example:"#FF5733"
parentobject(ApiChartAccountBasicReadDto)

Parent chart account

Default:""
observationsstring

Observations about the account

Default:""
bankobject(ApiBankListReadDto)

Bank account

Default:""
bankAccountstring

Bank account number (IBAN)

Default:""
Example:"ES7501234567890123456789"
bankAccountSwiftstring

Bank SWIFT/BIC code

Default:""
Example:"CAIXESBB"
forecastTypeobject(ApiForecastTypeListReadDto)

Forecast type

Default:""
installmentNumberinteger, (int32)

Number of installments

Default:""
installmentDaysinteger, (int32)

Days between installments

Default:""
installmentFirstDayinteger, (int32)

First installment day of the month

Default:""
installmentSecondDayinteger, (int32)

Second installment day of the month

Default:""
forecastMandatoryboolean

Indicates if forecast is mandatory

Default:false
forecastWithAccountingDateboolean

Indicates if forecast uses accounting date

Default:false
paymentEmailAddressstring

Email address for payments

Default:""
confirmingEmailAddressboolean

Indicates if confirming email address is enabled

Default:false
cadastralReferencestring

Cadastral reference

Default:""
operationKey340string(ApiOperationKey340Enum)

Operation key 340

Default:""
Enum:"USUAL_OPERATION""A""B""C""D""E""F""G""H""I"
lockDatestring, (date)

Lock date for the account

Default:""
accumulateCashboolean

Indicates if cash should be accumulated

Default:false
reccboolean

Indicates if RECC is applied

Default:false
creditBalanceboolean

Indicates if account has credit balance

Default:false
debitBalanceboolean

Indicates if account has debit balance

Default:false
higherBalanceAlertboolean

Indicates if higher balance alert is enabled

Default:false
higherBalanceAlertValuenumber

Higher balance alert threshold value

Default:""
lowerBalanceAlertboolean

Indicates if lower balance alert is enabled

Default:false
lowerBalanceAlertValuenumber

Lower balance alert threshold value

Default:""
cifstring

Tax identification number (CIF/NIF)

Default:""
Example:"B03186681"
taxIdentificationCodestring(ApiTaxIdentificationCodesEnum)

Tax identification code type

Default:""
Enum:"NIF""NIF_VAT""PASSPORT""OFFICIAL_IDENTIFICATION_NUMBER""RESIDENCE_CERTIFICATE""ANOTHER_EVIDENT_DOCUMENT""NOT_CENSUS"
businessNamestring

Business name

Default:""
Example:"Clave Informática"
address1string

Address line 1

Default:""
address2string

Address line 2

Default:""
postalCodestring

Postal code

Default:""
citystring

City

Default:""
statestring

State or province

Default:""
countryobject(ApiCountryListReadDto)

Country

Default:""
phone1string

Primary phone number

Default:""
phone2string

Secondary phone number

Default:""
fax1string

Primary fax number

Default:""
fax2string

Secondary fax number

Default:""
postalMailstring

Postal mail address

Default:""
emailstring

Email address

Default:""
webstring

Website URL

Default:""
legalRepresentativeCifstring

Legal representative CIF/NIF

Default:""
legalRepresentativeNamestring

Legal representative name

Default:""
classificationstring(ApiAccountClassificationEnum)

Account classification

Default:""
Enum:"ASSET""LIABILITY""INCOME""EXPENSE""EXPENSE_IMPUTED_LIABILITY""INCOME_IMPUTED_LIABILITY"
naturestring(ApiAccountNatureEnum)

Account nature

Default:""
Enum:"CREDITOR""DEBTOR"
signstring(ApiAccountSignEnum)

Account sign

Default:""
Enum:"POSITIVE""NEGATIVE"
statementBalanceColorstring(ApiAccountColorEnum)

Statement balance color

Default:""
Enum:"RED""GREEN"
accountingStatementColorstring(ApiAccountColorEnum)

Accounting statement color

Default:""
Enum:"RED""GREEN"
Response
{
  "id": "",
  "code": "4300000001",
  "description": "Clientes",
  "active": true,
  "color": "#FF5733",
  "parent": {
    "id": "",
    "code": "1000",
    "description": "Cash account"
  },
  "observations": "",
  "bank": null,
  "bankAccount": "ES7501234567890123456789",
  "bankAccountSwift": "CAIXESBB",
  "forecastType": {
    "id": "",
    "code": "string",
    "description": "string",
    "mandatoryBank": true,
    "paymentType": "BANK_ACCOUNT"
  },
  "installmentNumber": "",
  "installmentDays": "",
  "installmentFirstDay": "",
  "installmentSecondDay": "",
  "forecastMandatory": false,
  "forecastWithAccountingDate": false,
  "paymentEmailAddress": "",
  "confirmingEmailAddress": false,
  "cadastralReference": "",
  "operationKey340": "USUAL_OPERATION",
  "lockDate": "",
  "accumulateCash": false,
  "recc": false,
  "creditBalance": false,
  "debitBalance": false,
  "higherBalanceAlert": false,
  "higherBalanceAlertValue": "",
  "lowerBalanceAlert": false,
  "lowerBalanceAlertValue": "",
  "cif": "B03186681",
  "taxIdentificationCode": "NIF",
  "businessName": "Clave Informática",
  "address1": "",
  "address2": "",
  "postalCode": "",
  "city": "",
  "state": "",
  "country": null,
  "phone1": "",
  "phone2": "",
  "fax1": "",
  "fax2": "",
  "postalMail": "",
  "email": "",
  "web": "",
  "legalRepresentativeCif": "",
  "legalRepresentativeName": "",
  "classification": "ASSET",
  "nature": "CREDITOR",
  "sign": "POSITIVE",
  "statementBalanceColor": "RED",
  "accountingStatementColor": "RED"
}