Dashboards

Netbox palveluiden ohjeita


Netbox - NetAPI


This documentation was last updated on 5.2.2020.

Netbox's NetAPI is a programming interface for partners. NetAPI is a private service that requires access to a user ID, customer ID, and password access token. Partners have the opportunity to test the interface in a test environment by requesting IDs from Netbox customer service ([email protected]), for example. In addition, you can also get a ready-made implementation in PHP and C # for your own use, which allows the partner to implement integration into his system more easily with the help of examples.

The services are REST-style service requests in nature. Services are performed over an encrypted HTTPS connection. The JSON format is used as the transmission format for data structures. The success of service calls is indicated by standard http return codes (see HTTP status codes below).

NetAPI is backward compatible, which means maintaining or extending existing structures in a non-coercive way. Software using NetAPI should take this into account and avoid discarding responses that contain fields that were not yet known during the implementation phase. Similarly, backward compatibility means that NetAPI will not reject requests, even if the fields defined later are missing from the request. New services can be added with completely new structures.

The version of the service described in this document is 1.01. The purpose of version numbering is to express backward compatibility verification: MAJOR.MINOR; When the MAJOR version number changes (for example, 1.0 becomes 2.0), the service interface may not be fully compatible. When only the MINOR number changes, backward compatibility of the service interface is ensured.



API Service Requests:

Customers:
GET service_address/customers?search=<pattern>
GET service_address/customers/<customer_identifier>
POST service_address/customers/<customer_identifier>

Messages:
GET service_address/messages/available
GET service_address/messages/headers
GET service_address/messages/headers/<type>
GET service_address/messages/<type>
GET service_address/messages/id/<id>
GET service_address/messages/statuses/<vat_identifier>
POST service_address/messages
POST service_address/messages (resend)

Company data:
GET service_address/companies/<vat_identifier>
GET service_address/companies?search=<company_name>


Here you can test NetAPI Demo IDs, queries and see what they return:
NetAPI Demo -portal

HTTP-status codes

  • Code
  • Value
  • Description
  • 200
  • OK
  • Successful call
  • 204
  • No Data
  • No data available
  • 400
  • Bad Request
  • Call parameter error
  • 401
  • Unauthorized
  • Login is missing or the operation does not have permissions
  • 404
  • Not Found
  • The URL is probably invalid
  • 500
  • Internal Error
  • System error




  • Authentication

    The license record is created in two steps.

    Step 1:

    Service invitations require an access token from the login.

    Ticket generation
    GET service_address/tickets/<username>[/<customer_identifier>]

    username = NetAPI username
    customer_identifier = customer ID (e.g. Business ID or option -any-)

    Based on the username and customer ID, a ticket is generated for login. The request does not pass the password to the server at all.

    A customer ID can be entered as a user ID pair. In the absence of a customer ID, act as if the value of the user ID had been used as the customer ID. The customer ID can also be " -any- " ("line any line").

    Note that when creating a ticket with the “-any-” option (in the field <customer_identifier>) gives admin access to all materials of the companies under the ID (messages, data and storage and editing of customer data). by Alternatively, when entering, for example, a business ID in the field <customer_identifier>, the rights are limited only to the materials, data and customer data of the company in question.

    Parameters
    urlusernameNetAPI username
    urlcustomer identifierNetAPI customer ID associated with the username


    Data structure to be returned
    TicketRecord

    FieldTypeDescription
    versionstringstructure versio:"1.01"
    ticketstringtiketti
    expiresdate-timeticket period ends
    Ticket for login. The ticket is valid for two minutes.

    
    
    URL: https://<service_address>/tickets/NB1234DEMTEST/1234567-8
    	
    Return:
    
    {
    	"version":"1.01",
    	"ticket":"a33fe7c61bd51ef7c510fdeb7d840f75a105acaf",
    	"expires":"Thu, 14 Dec 2017 14:05:18 EET"
    }
    		
    	
    


    Step 2:

    Access token
    GET service_address/tokens/<secured_hash>

    An access token is generated based on the Secured hash. The request does not transmit a username, client ID, or password to the server at all.

    Parameters
    urlsecured_hashHexadecimal sha1-generated verified hash of consecutively concatenated password and Tiketti.
    Data structure
    TokenRecord

    FieldTypeDescription
    versionstringstructure version:"1.01"
    tokenstringKäyttöoikeustietue
    expiresdate-timeKäyttöoikeustietueen voimassaolo päättyy
    Käyttöoikeustietue ja lisätietoja. Käyttöoikeustietue on voimassa tunnin ajan.

    	
    URL: https://<service_address>/tokens/8ea7d2e8f5dd2260d225e563f04ba7afe956c7f2
    
    Return:
    
    {
    	"version":"1.01",
    	"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyIjoiTkI0MTA4QVNLVEVTVCIsImN1c3Rvb...f-Lds",
    	"expires":"Thu, 14 Dec 2017 16:36:26 EET"
    }
    		
    	
    

    Kaikki muut kutsut vaativat Returntun käyttöoikeustietueen (access token) Authorization headerinä:

    Authorization header
    Authorization: Bearer <käyttöoikeustietue>

    The functions of the session are limited to the clientele expressed in the authentication. For example, message fetching only picks up messages coming to the customer.

    When the customer ID is empty or the user ID itself, the functions are limited to the user ID information.
    When the customer ID is " -any- ", operations are limited to all customer IDs.













    Customer details

    Searching for customers with the search factor
    GET service_address/customers?search=<pattern>
    Parameters
    urlpatternSearch by
    You can use the % sign, e.g., CompanyName%, to search for all customers whose name begins with the "CompanyName".
    Returnable data structure (list of found customers)
    CustomerItemRecord

    FieldTypeDescription
    versionstringstructure version:"1.01"
    identifierstringCustomer id (in customers/HUB's software, generally VAT).
    namestringCustomer name.
    vat_identifierstringCustomer VAT.
    edi_identifierstringCustomer EDI id.
    free_textstringFree text.
    open_invoice_channelsstring • If the value of open_invoice_channels is 0, then the sales invoice channel is OFF and the purchase invoice channel is OFF (both closed).
    • If the value of open_invoice_channels is 1, then the sales invoice channel is ON and the purchase invoice channel is OFF.
    • If the value of open_invoice_channels is 2, then the sales invoice channel is OFF and the purchase invoice channel is ON.
    • If the value of open_invoice_channels is 3, then the sales invoice channel is ON and the purchase invoice channel is ON (both open).

    If the purchase invoice channel is closed (OFF = value 0 or 1), then the operator of the e-invoice sender automatically receives an error message (negative ACK message) that the e-invoice cannot be delivered to the recipient.
    	
    URL: https://<service_address>/customers?search=Yritys%20%Software%20%Oy
    
    Return:
    
    {
        "version": "1.01",
        "identifier": "1234567-8",
        "name": "Yritys Software Oy",
        "vat_identifier": "1234567-8",
        "edi_identifier": "003712345678",
        "free_text": "Vapaata lisätietoa",
        "open_invoice_channels": "3"
    }
    		
    	
    




    Retrieving customer information with a customer ID.
    GET service_address/customers/<customer_identifier>
    Parameters
    urlcustomer_identifiercustomer ID.
    Returnttava data structure (customer information except password)
    CustomerItemRecord

    FieldTypeDescription
    versionstringstructure version:"1.01"
    identifierstringCustomer ID.
    namestringCustomer name.
    vat_identifierstringCustomer business ID.
    edi_identifierstringCustomer EDI id.
    eaddress_sendbooleanFrom address into the TIEKE's e-invoice address register
    eaddress_receivebooleanTo address into the TIEKE's e-invoice address register
    free_textstringFree text.
    open_invoice_channelsstring • If the value of open_invoice_channels is 0, then the sales invoice channel is OFF and the purchase invoice channel is OFF (both closed).
    • If the value of open_invoice_channels is 1, then the sales invoice channel is ON and the purchase invoice channel is OFF.
    • If the value of open_invoice_channels is 2, then the sales invoice channel is OFF and the purchase invoice channel is ON.
    • If the value of open_invoice_channels is 3, then the sales invoice channel is ON and the purchase invoice channel is ON (both open).

    If the purchase invoice channel is closed (OFF = value 0 or 1), then the operator of the e-invoice sender automatically receives an error message (negative ACK message) that the e-invoice cannot be delivered to the recipient.
    	
    	URL: https://<service_address>/customers/1234567-8
    
    	Return:
    	
    
    	{
    		"version": "1.01",
    		"identifier": "1234567-8",
    		"name": "Yritys Software Oy",
    		"vat_identifier": "1234567-8",
    		"edi_identifier": "003712345678",
    		"eaddress_send": true,
    		"eaddress_receive": true,	
    		"free_text": "Vapaata lisätietoa"	
    		"open_invoice_channels": "3",
    		"address": {
    			"street": [
    				"Valtatie 66",
    				null,
    				null
    			],
    			"zipcode": "09100",
    			"city": "Kalihvornia",
    			"district": "Pirkanmaa",
    			"country": "Finland",
    			"phone": "044-7660001"
    		}
    	}	
    	
    	
    




    Create a new customer or update customer information.
    POST service_address/customers/<customer_identifier>
    Parameters
    urlcustomer_identifierCustomer ID. If not provided, an attempt is made to create a customer, otherwise an attempt will be made to update the customer information.
    bodyCustomerRecordCustomer data. When updating, the client ID must match the ID specified in the url parameter.
    Sending data structure
    CustomerRecord

    FieldTypeDescription
    versionstringstructure version:"1.01"
    identifierstringCustomer ID (in the client / HUB software, usually the Business ID).
    namestringCustomer name.
    vat_identifierstringCustomer VAT
    edi_identifierstringCustomer EDI id
    eaddress_sendbooleanFrom address into the TIEKE's e-invoice address register
    eaddress_receivebooleanTo address into the TIEKE's e-invoice address register
    open_invoice_channelsstring • If the value of open_invoice_channels is 0, then the sales invoice channel is OFF and the purchase invoice channel is OFF (both closed).
    • If the value of open_invoice_channels is 1, then the sales invoice channel is ON and the purchase invoice channel is OFF.
    • If the value of open_invoice_channels is 2, then the sales invoice channel is OFF and the purchase invoice channel is ON.
    • If the value of open_invoice_channels is 3, then the sales invoice channel is ON and the purchase invoice channel is ON (both open).

    If the purchase invoice channel is closed (OFF = value 0 or 1), then the operator of the e-invoice sender automatically receives an error message (negative ACK message) that the e-invoice cannot be delivered to the recipient.
    secretstringCustomer password. The field is only used for customer data updates The mechanism allows a NetAPI user to provide their customers with a password associated with a customer ID if they wish.
    addressCustomerRecord.AddressAddress (see structure below)
    contactCustomerRecord.ContactContact information (see structure below)
    supportCustomerRecord.SupportSupport contact information (see structure below)
    free_textstringFree text.
    Customer details
    CustomerRecord.Address

    FieldTypeDescription
    street[string]Street address. 1-4 riviä
    zipcodestringPost number
    citystringCity
    districtstringState
    countrystringCoutry
    phonestringPhone
    Customer details
    CustomerRecord.Address

    FieldTypeDescription
    street[string]Street address. 1-4 riviä
    zipcodestringPost number
    citystringCity
    districtstringState
    countrystringCoutry
    phonestringPhone
    Customer details
    CustomerRecord.Support

    FieldTypeDescription
    emailstringSähköpostiosoite
    	
    
    URL: https://<service_address>/customers/1234567-8
    
    body:
    
    {
    	"version":"1.01",
    	"identifier":"1234567-8",
    	"name": "Yritys Software Oy",
    	"vat_identifier": "1234567-8",
    	"edi_identifier": "003712345678",
    	"secret": "valinnainen",
    	"eaddress_send": "true",
    	"eaddress_receive": "false",
    	"free_text": "Tuki klo 09-13",	
    	"open_invoice_channels": "1",
    	
    	"address": 	[
    		{
    			"street": "Yrityksen nimi",
    			"zipcode": "01-01-2018",
    			"city": "31-12-2080",
    			"district": false,
    			"country": "Finland",
    			"phone": "040123456789"
    		}
    	],
    	"contact":	[
    		{
    			"first_name": "Matti",
    			"middle_name": "Masi",
    			"surname": "Meikäläinen",
    			"phone": "0401234567",
    			"email": "[email protected]"
    			
    		}
    	],
    	"support":	[
    		{
    			"email": "[email protected]"
    		}
    	]
    	
    	
    }
    		
    	
    













    MESSAGES

    Retrieving information from available messages
    GET service_address/messages/available
    Parameters
    No parameters
    Incoming data structure
    IncomingInfo

    FieldTypeDescription
    versionstringstructure version:"1.01"
    itemsintCount of incoming messages
    details[IncomingInfo.Details]Details of incoming messages (under)
    Message details
    IncomingInfo.Details

    FieldTypeDescription
    versionstringstructure version:"1.01"
    itemsintCount of incoming messages
    details[IncomingInfo.Details]Details of incoming messages
    Message details
    IncomingInfo.Details.Item

    FieldTypeDescription
    messagesintIncoming messages
    acksintIncoming ok messages (ACK)
    errorsintIncoming error messages (ACK)
    	
    URL: https://<service_address>/messages/available
    
    Return:
    
    {
        "version": "1.01",
        "items": 12
        "details": [
            {
                "receiver": "003702823456",
                "name": "Yritys Liikenne Ky",
                "items": {
                    "messages": "12",  
                    "acks": "11",
                    "errors": "1"
                }
            }
        ]
    }
    		
    	
    



    Retrieving header information as a list of available messages
    GET service_address/messages/headers
    Parameters
    No parameters
    Incoming data structure
    IncomingInfo

    FieldTypeDescription
    versionstringstructure version:"1.01"
    itemsintCount of incoming messages
    details[IncomingInfo.Details]Details of incoming messages (under)
    Message details
    IncomingInfo.Sender

    FieldTypeDescription
    address string Invoice address
    intermediator string Intermediator ID/address
    name string Sender name
    messageid int Netbox message id
    timestamp datetime Time stamp
    Message details
    IncomingInfo.Details.Item

    FieldTypeDescription
    address string Invoice address
    intermediator string Intermediator ID/address
    name string Vastaanottajan toiminimi
    	
    URL: https://<service_address>/messages/headers
    
    Return:
    
    [
        {
            "messageid": "1036",
            "type": invoice,
            "original_filename": "kollektor-Koll_20180410055506_0001",
            "handled": "2018-05-04 12:11:17",
            "sender": {
                "address": "14756079",
                "intermediator": "KOLLEKTORSCAN",
                "name": "Laskuttaja Lex Oy",
                "messageid": "75856097",
                "timestamp": "2018-04-08T13:40:00+0000"
            },
            "receiver": {
                "address": "003724563330",
                "intermediator": "003726044706",
                "name": "CRM House Oy"
            }
        }
    		
    	
    



    Retrieving header information as a list of available messages by message type
    GET service_address/messages/headers/<type>
    Parameters
    urltypeOptional cropping to the desired messageType. Message types can be found in connection with the description of the MessageData structure.
    Incoming data structure
    IncomingInfo

    FieldTypeDescription
    versionstringstructure version:"1.01"
    itemsintCount of incoming messages
    details[IncomingInfo.Details]Details of incoming messages (under)
    Message details
    IncomingInfo.Sender

    FieldTypeDescription
    address string Invoice address
    intermediator string Intermediator ID/address
    name string Sender name
    messageid int Netbox sanoma id
    timestamp datetime Time stamp
    Message details
    IncomingInfo.Details.Item

    FieldTypeDescription
    address string Invoice address
    intermediator string Intermediator ID/address
    name string Receiver name
    	
    URL: https://<service_address>/messages/headers/invoice
    
    Return:
    
    [
        {
            "messageid": "1036",
            "type": invoice,
            "original_filename": "kollektor-Koll_20180410055506_0001",
            "handled": "2018-05-04 12:11:17",
            "sender": {
                "address": "14756079",
                "intermediator": "KOLLEKTORSCAN",
                "name": "Laskuttaja Lex Oy",
                "messageid": "75856097",
                "timestamp": "2018-04-08T13:40:00+0000"
            },
            "receiver": {
                "address": "003724563330",
                "intermediator": "003726044706",
                "name": "CRM House Oy"
            }
        }
    		
    	
    



    Retrieving the next available message or part of it (queue search)
    GET service_address/messages/<type>

    The messages come according to fifo, i.e. the oldest message first.
    Parameters
    urltypeOptional cropping to the desired messageType. Message types can be found in connection with the description of the MessageData structure.
    Returnttava data structure (Details of message)
    MessageData

    FieldTypeDescription
    versionstringstructure version:"1.01"
    identifierstringMessage id
    typeenumSanoman Type
    datafiles[MessageData.DataFile]Details of message (under)
    Message details
    MessageData.DataFile

    FieldTypeDescription
    filenamestringfile name
    compressedinttrue if the data is gzipped before base64 encoding.
    database64dataFile data as base64-encoded binary mass.
    filesizeintThe original size of the file.
    filetimedate-timeThe last time the file was modified.
    The message types are:

    TypeDescription
    invoicee-invoice
    ackE-invoice ok or error acknowledgment
    bankstmtBank statement in CAMT053 format
    bankrefpReference fee in CAMT054 format
    	
    URL: https://<service_address>/messages
    
    Return:
    
    	{
    		"version": "1.01",
    		"identifier": "xml",
    		"type": "ack",
    		"datafiles":	
    		[
    			{
    				"data":"PFNPQVAtRU5WOkVudmV...2b2ljZWFjaz4K",
    				"filename":"ERR-171219150010860-52.xml",
    				"filesize":3684,
    				"filetime":"2017-12-19T15:03:55+0200",
    				"sha1":"d0357bd3543d322eb26cf04c8bc4094956390881"
    			}
    		]
    	}
    		
    	
    



    Retrieving a specific message with an identifier
    GET service_address/messages/id/<id>

    The search does not delete the message from the message queue, but is still retrievable by queue search.
    Parameters
    urlidMessage ID for a specific message. You can retrieve the message tag with the / headers / call.
    Retrunable data structure (Message details)
    MessageData

    FieldTypeDescription
    versionstringstructure version:"1.01"
    identifierstringMessage id
    typeenumSanoman Type
    datafiles[MessageData.DataFile]Details of messages (under)
    Message details
    MessageData.DataFile

    FieldTypeDescription
    filenamestringFile name
    compressedinttrue if the data is gzipped before base64 encoding.
    database64dataFile data as base64-encoded binary mass.
    filesizeintThe original size of the file.
    filetimedate-timeThe last time the file was modified.
    Sanoman tyypit ovat:

    TypeDescription
    invoicee-invoice
    ackE-invoice ok or error acknowledgment
    bankstmtBank statement in CAMT053 format
    bankrefpReference fee in CAMT054 format
    	
    URL: https://<service_address>/id/123456
    
    Return:
    
    	{
    		"version": "1.01",
    		"identifier": "1043",
    		"type": "ack",
    		"datafiles":	
    		[
    			{
    				"data":"PFNPQVAtRU5WOkVudmV...2b2ljZWFjaz4K",
    				"filename":"ERR-171219150010860-52.xml",
    				"filesize":3684,
    				"filetime":"2017-12-19T15:03:55+0200",
    				"sha1":"d0357bd3543d322eb26cf04c8bc4094956390881"
    			}
    		]
    	}
    		
    	
    



    SEND MESSAGE OR PART OF MESSAGE
    POST service_address/messages

    It is recommended that the message be sent in its entirety as a ZIP file. The files can also be sent separately, as a single service call or as separate service calls. The message identifier is for reference only. Separate files are not attached to a message using a message tag, but only based on the contents. The message identifier must be permanently unique. File names must be unambiguous for 6 months.
    Parameters
    urltypeOptional cropping to the desired message type.
    Data structure to be sent (message details)
    MessageData

    FieldTypeDescription
    versionstringstructure version:"1.01"
    identifierstringMessage Id
    typeenumSanoman Type
    datafiles[MessageData.DataFile]Message details (above)



    Resending message (resend)
    POST service_address/messages

    An already sent message, such as an invoice"resend".
    Parameters
    urltypeOptional cropping to the desired message type.
    Data structure to be sent (message details)
    MessageData

    FieldTypeDescription
    versionstringstructure version:"1.01"
    identifierstringMessage Id
    typeenumMessage Type
    datafiles[MessageData.DataFile]Message details (above)
    Message details
    MessageData.DataFile

    FieldTypeDescription
    filenamestringFile name
    compressedinttrue if the data is gzipped before base64 encoding.
    database64dataFile data as base64-encoded binary mass.
    filesizeintThe original size of the file.
    filetimedate-timeThe last time the file was modified.
    Sanoman tyypit ovat:

    TypeDescription
    invoicee-invoice
    ackE-invoice ok or error acknowledgment
    bankstmtBank statement in CAMT053 format
    bankrefpReference fee in CAMT054 format
    Message details
    Resend.Receiver

    FieldTypeDescription
    addressstringReceiver e-invoice address
    intermediatorstringReceiver intermediator address
    Resend.Sender

    FieldTypeDescription
    addressstringSender e-invoice address
    intermediatorstringSender intermediator e-invoice address (Netbox: 003726044706)
    messageidstringSender message Id (In Finvoice messages <MessageId>)
    SanomaType
    MessageData.Type

    FieldTypeDescription
    typestringMessage type (types listed in MessageData.DataFile section)
    	
    URL: https://<service_address>/messages
    
    Body:
    
    {
        "datafiles": [
            {
                "data": "...base64_encode...",
                "filename": "invoice_543_1234567890.xml",
                "filesize": 1122
            },
            {
                "data": "...base64_encode...",
                "filename": "invoice_543_1234567890.pdf",
                "filesize": 10022
            }
        ],
        "resend": {
            "receiver": {
                "address": "receiver_eaddress",
                "intermediator": "receiver_intermediator_address"
            },
            "sender": {
                "address": "sender_eaddress",
                "intermediator": "sender_intermediator_address",
                "messageid": "sender_message_id"
            }
        },
        "type": "invoice"
    }
    
    		
    	
    









    COMPANY DATA

    Searching for public company information with a business ID
    GET service_address/companies/<vat_identifier>
    Parameters
    urlvat_identifierCompany business ID
    data structure (Yrityksen tiedot)
    CompanyRecord

    FieldTypeDescription
    versionstringstructure version:"1.01"
    vat_identifierstringCompany business ID
    names[CompanyRecord.Name]Company name (under)
    addresses[CompanyRecord.Address]Company address details (under)
    eaddresses[CompanyRecord.Eaddress]Company e-invoice addresses (under)
    Company details
    CompanyRecord.Name

    FieldTypeDescription
    namestringCompany name
    start_datedateName effective date
    end_datedateExpiry date of the name
    auxbooleantrue for an auxiliary business name
    Osoitetiedot
    CompanyRecord.Address

    FieldTypeDescription
    street[string]Street address. 1-4 riviä
    zipcodestringPost number
    citystringCity
    countrystringCoutry
    start_datedateAddress effective date
    end_datedateAddress expiration date
    eaddress_id_typestring
    eaddress_id_valuestring
    eaddress_service
    typestringAddress type: Postal or visiting
    E-invoicing address information
    CompanyRecord.Eaddress

    FieldTypeDescription
    typestringAddress type. Types expressed using Eaddress v1.12 definition: ovt vatid businessid gln duns peppol mutual other iban bic businessid
    contextstringAddress context. Contexts are expressed by applying Eaddress v1.12 as defined: einvoice orders ordrsp pricat desadv other
    directionstringDirection. Directions are expressed by applying Eaddress v1.12 as defined: send receive
    addressstringAddress
    service_typestringService type
    service_identifierstringService ID
    	
    URL: https://<service_address>/companies/1234567-8
    
    Return:
    
    {
        "version": "1.01",
        "vat_identifier": "2604470-6",
        "names": [
            {
                "name": "Netbox Finland Oy",
                "start_date": "2014-03-04",
                "end_date": "",
                "aux": "false"
            }
        ],
        "addresses": [
            {
                "street": "Rautatienkatu 21",
                "zipcode": "33100",
                "city": "TAMPERE",
                "country": "",
                "type": "postal",
                "start_date": "2018-02-17",
                "end_date": ""
            },
            {
                "street": "Rautatienkatu 21",
                "zipcode": "33100",
                "city": "TAMPERE",
                "country": "",
                "type": "visiting",
                "start_date": "2018-02-17",
                "end_date": ""
            }
        ],
        "eaddresses": [
            {
                "type": "ovt",
                "context": "einvoice",
                "direction": "send",
                "address": "003726044706",
                "service_type": "ovt",
                "service_identifier": "003726044706"
            },
            {
                "type": "ovt",
                "context": "einvoice",
                "direction": "receive",
                "address": "003726044706",
                "service_type": "ovt",
                "service_identifier": "003726044706"
            }
        ]
    }
    		
    	
    



    Searching for company public information by business name
    GET service_address/companies?search=<company_name>

    Keyword(s) must be encoded in urlencode in PHP ($keyword);
    Parameters
    url?search=Company name or part of the name. The search is "case insensitive".
    Returnable data structure (Company details)
    CompanyRecord

    FieldTypeDescription
    versionstringstructure version:"1.01"
    Company data
    CompanyRecord.Results

    FieldTypeDescription
    vat_identifier string Business ID
    name string Company name
    street string Street address
    zipcode int Postcode
    city string City
    domicile string State
    	
    URL: https://<service_address>/companies?search=netbox%20%finland
    
    Return:
    
    {
        "version": "1.01",
        "results": [
            {
                "vat_identifier": "2604470-6",
                "name": "Netbox Finland Oy",
                "street": "Rautatienkatu 21  ",
                "zipcode": "33100",
                "city": "TAMPERE",
                "domicile": "TAMPERE"
            },
            {
                "vat_identifier": "1306336-9",
                "name": "Tmi Netbox",
                "street": "   ",
                "zipcode": null,
                "city": null,
                "domicile": "PAIMIO"
            },
            {
                "vat_identifier": "2938504-7",
                "name": "NETBOX PL SP. Z O.O.",
                "street": "   ",
                "zipcode": null,
                "city": null,
                "domicile": "ULKOMAAT"
            }
        ]
    }