Skip to content

patchSupplier

Request

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

Responses

OK

Bodyapplication/json
idinteger, (int32)required

Unique identifier of the object

Default:""
codeinteger, (int32)

Supplier numeric code. Unique per company.

Default:""
Example:20001
cifstring

Tax identification code (CIF/NIF).

Default:""
Example:"B87654321"
commercialNamestring

Commercial name of the supplier.

Default:""
Example:"Supplier Corp"
vatobject(ApiCustomerVatTypeListReadDto)

VAT type information.

Default:""
namestring

Legal name of the supplier.

Default:""
Example:"Supplier Corporation S.L."
addressstring

Postal address.

Default:""
Example:"Calle Mayor, 10"
countryobject(ApiCountryListReadDto)

Country information.

Default:""
stateobject(ApiStateListReadDto)

State information.

Default:""
postalCodestring

Postal code.

Default:""
Example:"28001"
citystring

Supplier city.

Default:""
Example:"Madrid"
phone1string

First phone number.

Default:""
Example:"+34911222333"
phone2string

Second phone number.

Default:""
Example:"+34911444555"
replacementTimenumber

Replacement time in days.

Default:""
Example:7
languageobject(ApiLanguageListReadDto)

Language information.

Default:""
currencyobject(ApiCurrencyListReadDto)

Currency information.

Default:""
manufacturerboolean

True if the supplier is a manufacturer.

Default:false
Example:false
importerboolean

True if the supplier is an importer.

Default:false
Example:true
activeboolean

True if the supplier is active.

Default:false
Example:true
notCreateOrderboolean

True if orders should not be created automatically.

Default:false
Example:false
observationstring

General observations about the supplier.

Default:""
Example:"Premium supplier with fast delivery"
geographicalLocationstring(ApiGeographicalLocationEnum)

Geographical location type.

Default:""
Enum:"CEUTA_MELILLA_CANARIAS""COMMUNITY""NATIONAL""OTHERS"
Example:"NATIONAL"
creationDatestring, (date)

Date of supplier creation. Format: yyyy-MM-dd

Default:""
Example:"2021-03-15"
inactiveDatestring, (date)

Date when supplier became inactive. Format: yyyy-MM-dd

Default:""
Example:"2024-10-01"
accountingAccountobject(ApiChartAccountListReadDto)

Accounting account information.

Default:""
customerobject(ApiCustomerListReadDto)

Associated customer information if supplier is also a customer.

Default:""
operatorobject(ApiOperatorReadDto)

Operator information.

Default:""
warehouseobject(ApiWarehouseListReadDto)

Default warehouse information.

Default:""
emailstring

Contact email address.

Default:""
Example:"contact@suppliercorp.com"
paymentMethodobject(ApiPaymentMethodListReadDto)

Payment method information.

Default:""
termsinteger, (int32)

Number of payment terms.

Default:""
Example:3
daysFirstTerminteger, (int32)

Days until first payment term.

Default:""
Example:30
daysBetweenTermsinteger, (int32)

Days between payment terms.

Default:""
Example:30
discount1number

First discount rate (percentage).

Default:""
Example:3.5
discount2number

Second discount rate (percentage).

Default:""
Example:2
discountPpnumber

Prompt payment discount rate (percentage).

Default:""
Example:1.5
proximityTypestring(ApiProximityTypeEnum)

Proximity type for payment calculation.

Default:""
Enum:"NEARBY""PREVIOUS""LATER"
Example:"FOLLOWING_MONTH"
paymentDay1integer, (int32)

First payment day of month.

Default:""
Example:10
paymentDay2integer, (int32)

Second payment day of month.

Default:""
Example:20
paymentDay3integer, (int32)

Third payment day of month.

Default:""
Example:30
weekdaystring(ApiWeekDayEnum)

Preferred payment weekday.

Default:""
Enum:"MONDAY""TUESDAY""WEDNESDAY""THURSDAY""FRIDAY""SATURDAY""SUNDAY"
Example:"FRIDAY"
paymentMethodObservationobject(ApiObservationListReadDto)

Payment method observation.

Default:""
paymentMethodObservationDescriptionstring, [ 0 .. 255 ] characters

Payment method observation description.

Default:""
Example:"Bank transfer preferred"
accountstring, [ 0 .. 50 ] characters

Bank account number.

Default:""
Example:"ES7921000813610123456789"
swiftstring, [ 0 .. 20 ] characters

SWIFT code.

Default:""
Example:"BBVAESMM"
bicstring, [ 0 .. 20 ] characters

BIC code.

Default:""
Example:"BBVAESMMXXX"
agencyobject(ApiAgencyListReadDto)

Bank agency information.

Default:""
shippingTermobject(ApiShippingTermListReadDto)

Shipping term information.

Default:""
ropoCodestring

ROPO registration code.

Default:""
Example:"ES-12345-ROPO"
ropoExpireDatestring, (date)

ROPO expiration date. Format: yyyy-MM-dd

Default:""
Example:"2025-12-31"
tagsArray of strings

List of supplier tags.

Default:""
Example:
[
  "PREMIUM",
  "INTERNATIONAL"
]
irpfTypestring(ApiIRPFTypeEnum)

IRPF type for withholding tax.

Default:""
Enum:"LEASES""PROFESIONAL_ACTIVITIES""AGRO""AGRO_REAGP"
Example:"IRPF_15"
bankNamestring

Bank name for the supplier.

Default:""
Example:"BBVA"
contactPersonstring

Contact person name.

Default:""
Example:"Juan García"
picturestring

Picture or logo for the supplier.

Default:""
Example:"https://www.suppliercorp.com/logo.png"
pictureTokenstring

Token for accessing the picture.

Default:""
Example:"a1b2c3d4e5f6"
incomeTaxRatenumber

Income tax rate (percentage).

Default:""
Example:15
webstring

Supplier web site.

Default:""
Example:"https://www.suppliercorp.com"
modifiedOnstring, (date-time)

Last modification date and time. Format: yyyy-MM-dd'T'HH:mm:ssXXX

Default:""
Example:"2024-12-10T14:30:00+01:00"
observationsArray of objects(ApiCustomerObservationListReadDto)

List of observations.

Default:""
filesArray of objects(ApiCustomerFileListReadDto)

List of attached files.

Default:""
purchasingAccountobject(ApiChartAccountListReadDto)

Purchasing account information.

Default:""
vatOperationTypeobject(ApiVatOperationTypeListReadDto)

VAT operation type information.

Default:""
reportLanguagestring(ApiAllowedLanguagesEnum)

Report language.

Default:""
Enum:"EN""ES""CA"
Response
{
  "id": "",
  "code": 20001,
  "cif": "B87654321",
  "commercialName": "Supplier Corp",
  "vat": {
    "id": "",
    "code": "GENERAL",
    "description": "General VAT type"
  },
  "name": "Supplier Corporation S.L.",
  "address": "Calle Mayor, 10",
  "country": null,
  "state": {
    "id": "",
    "code": "28",
    "description": "Madrid",
    "country": null,
    "isoCode": "ES-M"
  },
  "postalCode": "28001",
  "city": "Madrid",
  "phone1": "+34911222333",
  "phone2": "+34911444555",
  "replacementTime": 7,
  "language": null,
  "currency": null,
  "manufacturer": false,
  "importer": true,
  "active": true,
  "notCreateOrder": false,
  "observation": "Premium supplier with fast delivery",
  "geographicalLocation": "CEUTA_MELILLA_CANARIAS",
  "creationDate": "2021-03-15",
  "inactiveDate": "2024-10-01",
  "accountingAccount": {
    "id": "",
    "code": "1000",
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": "100",
    "parentDescription": "Assets"
  },
  "customer": null,
  "operator": null,
  "warehouse": {
    "id": "",
    "code": "ALM01",
    "description": "Central warehouse",
    "population": "Madrid",
    "active": true
  },
  "email": "contact@suppliercorp.com",
  "paymentMethod": null,
  "terms": 3,
  "daysFirstTerm": 30,
  "daysBetweenTerms": 30,
  "discount1": 3.5,
  "discount2": 2,
  "discountPp": 1.5,
  "proximityType": "NEARBY",
  "paymentDay1": 10,
  "paymentDay2": 20,
  "paymentDay3": 30,
  "weekday": "MONDAY",
  "paymentMethodObservation": null,
  "paymentMethodObservationDescription": "Bank transfer preferred",
  "account": "ES7921000813610123456789",
  "swift": "BBVAESMM",
  "bic": "BBVAESMMXXX",
  "agency": {
    "id": "",
    "code": "AG001",
    "name": "Fast Transport Agency"
  },
  "shippingTerm": null,
  "ropoCode": "ES-12345-ROPO",
  "ropoExpireDate": "2025-12-31",
  "tags": [
    "PREMIUM",
    "INTERNATIONAL"
  ],
  "irpfType": "LEASES",
  "bankName": "BBVA",
  "contactPerson": "Juan García",
  "picture": "https://www.suppliercorp.com/logo.png",
  "pictureToken": "a1b2c3d4e5f6",
  "incomeTaxRate": 15,
  "web": "https://www.suppliercorp.com",
  "modifiedOn": "2024-12-10T14:30:00+01:00",
  "observations": "",
  "files": "",
  "purchasingAccount": {
    "id": "",
    "code": "1000",
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": "100",
    "parentDescription": "Assets"
  },
  "vatOperationType": {
    "id": "",
    "code": "E01",
    "description": "Intra-community acquisition of goods",
    "model347": true,
    "model349": false,
    "selfImposed": false
  },
  "reportLanguage": "EN"
}