Onboard a company

post https://example.com/onboarding/v2/companies

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

Supplier — Usually a business.
Customer — Can be an individual (B2C transaction) or a company (B2B transaction).

This Company onboarding endpoint allows you to onboard Supplier and Customer companies into the Fonoa system. If the Customer is an individual (i.e., B2C transaction) and its details need to be reported to the tax authority, you should use the individual onboarding endpoint.

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.

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

time	status	user agent
Retrieving recent requests…

Loading…

Body Params

address

object

required

The address where the company is registered.

Validations (apply for all countries):

Required property

company_number

string

required

Company’s local identification number, usually identical to TIN.

Validations (apply for all countries):

Required property
Length between 1 and 50

contact_details

object

Contact details for the company.

establishment_date

string

The date when the company was established or business activity started. Establishment Date should be in ISO8601 standard.

legal_name

string

required

The company's legal name.

Validations (apply for all countries):

Required property
Length between 1 and 450

logo

string

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

meta

object

representative_email

string

representative_name

string

tax_credentials

object

Tax credentials to report transactions.

tax_information

object

required

Tax information for the company.

Validations (per country) - for full countries documentation reach out to Fonoa:

Portugal:

Required property

template_configuration

object

Settings related to how your invoicing template will look like - like color, font

trade_name

string

Validations (apply for all countries):

Length between 0 and 450

Responses

401

Authentication failed - missing or incorrect subscription key.

409

Conflict - the company already exists.

429

Too many requests were sent for a short period of time. Try again a bit later.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://example.com/onboarding/v2/companies \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Accepted - company was successfully onboarded.

400Bad customer request - some of the provided information is incorrect or mandatory data is missing. Check the message and errors section of the response for more details.

5XXInternal server error. Its not you, its us! We are experiencing a rare and unexpected system disruption. Retry again later. The message field of the response will contain more information for the cause. Feel free to contact us.