E-Invoicing Endpoints

Update company details

Changed on

Used to update details for an existing onboarded company. Only the fields listed here are avaible to update. PATCH operations are synchronous, contrary to POST ones.

patch/onboarding/v2/companies/{id}

Request

  • Base URL
    https://api-demo.fonoa.com
  • URL
    https://api-demo.fonoa.com/onboarding/v2/companies/{id}
  • Auth
    API key in header Ocp-Apim-Subscription-Key

Path parameters

idstring required

The identifier of the company

Request body

legal_namestring
company_numberstring

Example request

{
  "meta": {
    "language_code": "en"
  },
  "address": {
    "city": "Paris"
  }
}

Response

Company response

status'success' | 'failed' | 'in-progress'
messagestring nullable

Example response

{
  "status": "success",
  "data": {
    "id": "ab52e24c64364fc7ae0fa098c242c4d9",
    "meta": {
      "external_id": "Account0001HU",
      "language_code": "hu",
      "country_code": "hu"
    },
    "legal_name": "Business Customer",
    "company_number": "13353298-1-44",
    "address": {
      "country_code": "IE",
      "province": "Quebec",
      "region": "West",
      "state": "Minnesota",
      "disctrict": "District of Light",
      "canton": "Ticino",
      "city": "Dublin",
      "neighbourhood": "Green Garden",
      "postal_code": "10000Z",
      "address_line_1": "752 A, Silky roads, Split",
      "address_line_2": "801, Big Bells, Goodville",
      "number": "120A",
      "prefix": "Alley",
      "suffix": "Avenue"
    },
    "tax_information": {
      "tax_number": "69061864-2-99",
      "regime": "VAT"
    },
    "tax_credentials": {
      "certificate_base64": "BASE64",
      "certificate_password": "CERTIFICATE_PWD",
      "username": "USERNAME",
      "password": "PASSWORD"
    },
    "created_at": "2021-08-20T13:18:55.5924614+00:00"
  },
  "message": "null"
}

Changes

    • breaking

      request body became required

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • warning

      removed from the request property allOf list

    • warning

      removed from the request property allOf list

    • warning

      removed from the request property allOf list

    • 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

      added the new failed enum value to the response property for the response status

    • warning

      added the new in-progress enum value to the response property for the response status

    • warning

      added the new success enum value to the response property for the response status

    • info

      api operation id updateCompany was added

    • info

      api tag E-Invoicing Endpoints added

    • 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 new optional request property /

    • info

      added the new optional request property /

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success 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 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 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

      removed from the response property allOf list for the response status

    • info

      the response's property default value success was added for the status