E-Invoicing Endpoints

Onboard a company

Changed on

Each transaction consists of at least two parties: Supplier and Customer. The Supplier is a company. On the other side of the transaction, the Customer can be an individual (B2C transaction) or a company (B2B transaction).

To report invoices in real-time to a tax authority, you need to onboard the Supplier that participate in the transaction.

This Company onboarding endpoint allows you to onboard Supplier companies into the Fonoa system.

When you are the Supplier and are using Fonoa to generate invoices or report transactions for your own company, you can use this endpoint to give us your company information. If you are a marketplace with multiple Suppliers, you can use this endpoint to onboard each active Supplier.

post/onboarding/v2/companies

Request

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

Request body

legal_namestring required

The company's legal name.

trade_namestring

The company's trade name.

company_numberstring required

Company’s local identification number, usually identical to TIN. Used for deduplication purposes.

representative_namestring
representative_emailstring
logostring

Url of the logo to be used in invoice documents for this company

Example request

{
  "meta": {
    "external_id": "Account0001HU",
    "language_code": "hu",
    "country_code": "hu"
  },
  "legal_name": "Supplier ABC",
  "trade_name": "Supplier Trade Name ABC",
  "company_number": "69061864-2-99",
  "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"
  }
}

Response

The Accepted response

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

The status of the POST request.

messagestring nullable

Example response

{
  "status": "success",
  "data": {
    "job_id": "fad3e91a0a46489cbcb82db1693df05b",
    "job_status_location": "https://api-demo.fonoa.com/onboarding/v2/jobs/fad3e91a0a46489cbcb82db1693df05b"
  },
  "message": "\"\""
}

Changes

    • breaking

      added the new required request property /

    • breaking

      added the new required request property /

    • breaking

      added the new required request property /

    • breaking

      added the new required request property /

    • breaking

      added the new required request property /

    • breaking

      request body became required

    • breaking

      the request property became required

    • breaking

      the request property 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 from the request property allOf list

    • warning

      removed from the request property allOf list

    • warning

      the request property's maxLength was set to 50

    • warning

      the request property's maxLength was set to 450

    • warning

      the request property's maxLength was set to 450

    • 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 onboardCompany 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

      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

      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

      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

      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

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new required request property / with a default value

    • info

      added the new required request property / with a default value

    • info

      added the new required request property / with a default value

    • info

      added the new required request property / with a default value

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property default value 69061864-2-99 was added

    • 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

      removed from the response property allOf list for the response status

    • info

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

    • info

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