Skip to content

patchCountry

Request

Path
idinteger, (int32)required
Bodyapplication/jsonrequired
property name*anyadditional property
PATCH
/api/v1/country/{id}
curl -i -X PATCH \
  'https://api.prana.software/api/v1/country/{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, non-emptyrequired

Country code (usually ISO numeric or custom).

Default:""
Example:"724"
languageobject(ApiLanguageListReadDto)

Official language object. See LanguageListReadDto.java for structure.

Default:""
currencyobject(ApiCurrencyListReadDto)

Reference currency object for this country. See CurrencyListReadDto.java for structure.

Default:""
agencyobject(ApiAgencyListReadDto)

Associated agency information. See AgencyListReadDto.java for structure.

Default:""
geographicalLocationstring(ApiGeographicalLocationEnum)required

Geographical location of the country. See GeographicalLocationEnum enum for possible values.

Default:""
Enum:"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
Example:"EUROPE"
descriptionstring, non-emptyrequired

Country name or description.

Default:""
Example:"Spain"
prefixstring

Phone prefix of the country.

Default:""
Example:"+34"
internationalCodestring

International country code.

Default:""
Example:"ES"
accountingAccountobject(ApiChartAccountListReadDto)

Accounting account for this country. See ChartAccountListReadDto.java for structure.

Default:""
intrastatCodestring

Intrastat commodity code for international trade.

Default:""
Example:"1000"
intrastatUnitsstring

Unit of measurement for Intrastat declarations.

Default:""
Example:"KG"
intrastatPercentagenumber

Percentage used for Intrastat reporting.

Default:""
Example:1.5
observationsstring

Additional observations or notes about the country.

Default:""
Example:"Is a member of EU since 1986."
isoCodestring(ApiAlpha2CountryCodeEnum)

ISO Alpha-2 country code.

Default:""
Enum:"AD""AE""AF""AG""AI""AL""AM""AO""AQ""AR"
Example:"ES"
alpha3IsoCodestring(ApiAlpha3CountryCodeEnum)

ISO Alpha-3 country code.

Default:""
Enum:"AFG""ALA""ALB""DZA""ASM""AND""AGO""AIA""ATA""ATG"
Example:"ESP"
fdiCodestring

FDI country code.

Default:""
Example:"ES"
sepaZoneboolean

True if country participates in SEPA zone.

Default:false
Example:true
includeAddressInSepaboolean

If true, country address is included for SEPA operations.

Default:false
Example:false
creditSuretystring

Credit surety information for the country.

Default:""
Example:"Credit insurance with national provider"
languagesobject

Map of language keys and their description for this country. Example: {"es": "Español", "en": "English"}

Default:""
customerVatTypeobject(ApiCustomerVatTypeListReadDto)

Customer VAT type for this country. See CustomerVatTypeListReadDto.java for structure.

Default:""
Response
// No response example