Company

Update the editable fields of an existing company

Changed on

Updates 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.

post/public/company/v1/update-company

Request

  • Base URL
    https://api.maqqie.app (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Client credentials
    Token URLhttps://maqqie.app/auth/realms/maqqie/protocol/openid-connect/token

Request body

companyIdstring uuid required
tradeNamestring

The trade name (handelsnaam / display name) of the company. Not the statutory name.

ibanstring

The IBAN of the company.

collectiveLabourAgreementNumberinteger

The unique number of the collective labour agreement, as returned from the /get-collective-labour-agreements endpoint. Note: the CLA can only be changed while the company is not yet active and has no orders on its current CLA.

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.

companyIdstring uuid required
chamberOfCommerceNumberstring required

Read-only. Sourced from the chamber of commerce and cannot be updated.

vatNumberstring

Read-only. Sourced from the chamber of commerce and cannot be updated.

statutoryNamestring

Read-only. The statutory (legal) name, sourced from the chamber of commerce and cannot be updated.

tradeNamestring required

The trade name (handelsnaam / display name) of the company.

collectiveLabourAgreementNumberinteger

The unique number of the collective labour agreement currently applied to the company.

ibanstring

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 object for status

    • breaking

      the response's body type changed from no type to string for 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

      the request's body type changed from object to no type

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response's body type changed from string to 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/json enum value removed CLA_CHANGE_NOT_ALLOWED

    • info

      response schema application/json enum value removed INVALID_IBAN

    • info

      response schema application/json enum value removed INVALID_PAYMENT_TERM_DAYS

    • info

      response schema application/json enum value removed INVALID_PROVISIONS

    • info

      response schema application/json enum value removed INVALID_SURCHARGE_PERCENTAGE

    • info

      response schema application/json enum value removed INVALID_TRADE_NAME

    • info

      response schema application/json enum value removed UNSUPPORTED_CLA_NUMBER