Company

Retrieve the current Maqqie-stored data of a company

Changed on
get/public/company/v1/get-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

Query parameters

companyIdstring uuid required

Response

Successfully retrieved the company

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

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