Update the editable fields of an existing company
Changed onUpdates the editable fields of a company. This is a partial update: only the fields present in the request are changed; omitted fields are left untouched.
Identity fields (chamber of commerce number, VAT number and statutory name) are sourced from the chamber of commerce and cannot be updated through this endpoint.
Updated provisions take effect from the moment of the update onwards: they are applied to new orders and placements created after this call. Existing orders and placements keep the provisions that were in effect when they were created and are not updated retroactively.
An updated payment term follows the same rule: it applies to invoices generated after this call, while invoices that were already generated keep the term they were issued with.
Request
- Base URLhttps://api.maqqie.app (the document declares no server; this is the origin it was published from)
- AuthOAuth 2Client credentialsToken URLhttps://maqqie.app/auth/realms/maqqie/protocol/openid-connect/token
Request body
Example request
{
"iban": "NL24RABO0648620387",
"provisions": {
"fixedCostPriceFactor": 1.95,
"percentage": 18.2,
"minimumAmount": 18.21
},
"paymentTerm": {
"days": 30,
"surchargePercentage": 2.5
}
}Response
Successfully updated the company. Returns the full, current company data.
Example response
{
"chamberOfCommerceNumber": "69831955",
"vatNumber": "NL290284636B95",
"iban": "NL24RABO0648620387",
"provisions": {
"fixedCostPriceFactor": 1.95,
"percentage": 18.2,
"minimumAmount": 18.21
},
"paymentTerm": {
"days": 30,
"surchargePercentage": 2.5
}
}Changes
- breaking
added the new required request property
- breaking
the request's body type changed from no type to
object - breaking
the response's body type changed from no type to
objectfor status - breaking
the response's body type changed from no type to
stringfor status - info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
added the new optional request property
- info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status - info
added the required property
to the response with the status
- breaking
- breaking
the request's body type changed from
objectto no type - breaking
the response's body type changed from
objectto no type for status - breaking
the response's body type changed from
stringto no type for status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - breaking
removed the required property
from the response with the status - warning
removed the request property
- warning
removed the request property
- warning
removed the request property
- warning
removed the request property
- warning
removed the request property
- warning
removed the request property
- warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - warning
removed the optional property
from the response with the status - info
response schema
application/jsonenum value removedCLA_CHANGE_NOT_ALLOWED - info
response schema
application/jsonenum value removedINVALID_IBAN - info
response schema
application/jsonenum value removedINVALID_PAYMENT_TERM_DAYS - info
response schema
application/jsonenum value removedINVALID_PROVISIONS - info
response schema
application/jsonenum value removedINVALID_SURCHARGE_PERCENTAGE - info
response schema
application/jsonenum value removedINVALID_TRADE_NAME - info
response schema
application/jsonenum value removedUNSUPPORTED_CLA_NUMBER
- breaking