| Table of Contents |
|---|
Version 1.13 914 26.810.20112016
Administrative functions
SendRegistrationInfo
...
PRODUCTION URL:
https://api.apix.fi/registration?id=<company-y-tunnus>id>&idq=<id qualifier>
TEST URL:
https://test-api.apix.fi/registration?id=<company-y-tunnus>id>&idq=<id qualifier>
HTTP Method:
PUT
Authentication:
No.
Parameters:
<company-y-tunnus>id> | is the official id of the company (in Finland y-tunnus (www.ytj.fi), in Sweden Org.nr (http://www.bolagsverket.se) |
<id qualifier> | is optional qualifier for the identification; y-tunnus, orgnr (default: y-tunnus) |
Request: |
See: ?1- Request message structure
Ytunnus | Y-tunnus, Org.nr (the unique company-id assigned by authoritiesthe local authority) |
Name | Name of the company |
AdditionalName | Additional name of the company |
FieldOfBusiness | The company's field of businnes |
CompanyForm | The company form (for example ltd.) |
AddressType | Type of address (Official, Visiting, Billing) |
Street1 | Street address (line1) |
Street2 | Street address (line2) |
PostalOffice | Postal Office |
PostalCode | Postal code |
Country | Country code, ISO 3166-1-alpha-2 |
Email address | |
Www | www address |
Phonenumber | Phone number |
ContactPerson | Name of the contact person |
LanguageCoded | Language code, ISO639-1 |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Request version="1.0">
<Content>
<Group>
<Value type="Ytunnus">2332748-7</Value>
<Value type="Name">Apix Messaging Oy</Value>
<Value type="FieldOfBusiness">Tietojenkäsittelyn ja laitteistojen käyttö- ja hallintapalvelut (62030)</Value>
<Value type="CompanyForm">Osakeyhtiö</Value>
<Value type="Email">Veli-Matti.Sahlberg@apix.fi</Value>
<Value type="Www">www.apix.fi</Value>
<Value type="Phonenumber">+358453444401</Value>
<Value type="ContactPerson">Veli-Matti Sahlberg</Value>
<Value type="LanguageCoded">fi</Value>
</Group>
<Group>
<Value type="AddressType">Official</Value>
<Value type="Street1">Hietalahdenkatu>Sinikalliontie 2B18<9</Value>
<Value type="PostalOffice">Helsinki<>Espoo</Value>
<Value type="PostalCode">00180<>02630</Value>
<Value type="Country">FI</Value>
</Group>
<Group>
<Value type="AddressType">Visiting</Value>
<Value type="Street1">Hietalahdenkatu>Sinikalliontie 2B18<9</Value>
<Value type="PostalOffice">Helsinki<>Espoo</Value>
<Value type="PostalCode">00180<>02630</Value>
<Value type="Country">FI</Value>
</Group>
<Group>
<Value type="AddressType">Billing</Value>
<Value type="Street1">Hietalahdenkatu>Sinikalliontie 2B18<9</Value>
<Value type="PostalOffice">Helsinki<>Espoo</Value>
<Value type="PostalCode">00180<>02630</Value>
<Value type="Country">FI</Value>
</Group>
</Content>
</Request>
HTTP/1.1 200 OK
Date: Fri, 11 Jun 2010 23:59:59 GMT
Content-Type: application/xml
Content-Length: 358
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response version="1.0">
<Status>OK</Status>
<StatusCode>5000</StatusCode>
<FreeText language="en">OK</FreeText>
<Content>
<Group>
<Value type="Records">4</Value>
<Value type="Operation">CREATE</Value>
</Group>
</Content>
</Response>
|
...
Description | |
|---|---|
Ytunnus | Company's registered ycompany id (Y-tunnus, Org.no) |
Name | Company name |
AdditionalName | Additional name |
CustomerNumber | Internal customer number |
UniqueCompanyID | Unique company id |
Registered email | |
Www | www-address |
Phonenumber | Registered phone number |
ContactPerson | Contact person's name |
LanguageCoded | The culture i.e fi_FI, en_US, se_SE |
IdCustomer | Internal customer id |
...
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
<Status>OK</Status>
<StatusCode>5000</StatusCode>
<FreeText language="en">OK</FreeText>
<Content>
<Group>
<Value type="Ytunnus">2332748-7</Value>
<Value type="Name">Apix Messaging Oy</Value>
<Value type="CustomerNumber">1</Value>
<Value type="UniqueCompanyID">fdf09a47-5e99-4773-9379-3f26c8861eea</Value>
<Value type="Email">Veli-Matti.Sahlberg@apix.fi</Value>
<Value type="Www">www.apix.fi</Value>
<Value type="Phonenumber">+358453444401</Value>
<Value type="ContactPerson">Veli-Matti Sahlberg</Value>
<Value type="LanguageCoded">fi</Value>
</Group>
<Group>
<Value type="AddressType">Official</Value>
<Value type="Street1">Hietalahdenkatu>Sinikalliontie 2B18<9</Value>
<Value type="PostalOffice">Helsinki<>Espoo</Value>
<Value type="PostalCode">00180<>02630</Value>
<Value type="Country">Finland</Value>
</Group>
</Content>
</Response>
|
...
PRODUCTION URL: https://api.apix.fi/app-transferID?id=<company y-tunnus>id>&idq=<id qualifier>&uid=<UserID>&ts=<timestamp>&d=SHA-256:<digest>
TEST URL: https://test-api.apix.fi/app-transferID?id=<company y-tunnus>id>&idq=<id qualifier>&uid=<UserID>&ts=<timestamp>&d=SHA-256:<digest>
...
See: ?appendix- SHA-256 usage in APIX webservices API
Parameters:
<company y-tunnus>id> | is the official identification id of the company (in Finland y-tunnus (www.ytj.fi), in Sweden Org.nr (http://www.bolagsverket.se) as used in the registration |
<id qualifier> | is optional qualifier for the identification; y-tunnus, orgnr (default: y-tunnus) |
<uid> | User ID for the user |
<ts> | Current timestamp |
<digest> | SHA-256 digest |
...
- eInvoiceAddress (IBAN, NETSERVICEID, OVT etc.). The value user has stored in the eInvoiceAddress field in software
- OVT (enchanced company identifier)
- y-tunnus/Org.nr (the official identifer for the company)
Note Preferred way is to use DeliveryMethod instead of PricingInfo
PRODUCTION URL:https://api.apix.fi/pricing?uid=<TransferID>&t=<timestamp>&d=SHA-256:<digest>
TEST URL:https://test-api.apix.fi/pricing?uid=<TransferID>&t=<timestamp>&d=SHA-256:<digest>
...
DocumentID | Optional: Document identifier at sender |
SenderName | Sender's official name |
SenderYtunnus | Sender's BusinessIDofficial id of the company (in Finland y-tunnus (www.ytj.fi), in Sweden Org.nr (http://www.bolagsverket.se) |
ReceiverName | Receiver's official name |
ReceiverCountryCode | Optional: Receiver's country code, ISO 3166-1, default FI |
ReceiverYtunnus | Optional: Receiver's BusinessID (ie. the official id) |
ReceiverOVT | Optional: Receiver's OVT-id (any enchanced party identifier) |
ReceivereInvoiceAddress | Optional: Receiver's eInvoiceAddress, eT@G or other specific electronic address |
MessageType | Optional: Messagetype used (eInvoice,invoic,orders etc.) Default: eInvoice |
LetterPages | Optional: Number of pages in letter |
...
DocumentID | Optional: Document identifier at sender |
ChannelName | Delivery channel: "eInvoice","Paper","email","EDI","Netpost","e-lasku","Suoramaksu" |
SenderName | Sender's official name |
SenderYtunnus | Sender's BusinessID (ie. the official registered id) |
ReceiverName | Receiver's official name |
CostInCredits | The cost of delivery in credits |
ReceiverYtunnus | Optional: Only for EINVOICE, EDI: Receiver's BusinessID |
MessageType | Messagetype used (eInvoice,invoic,orders etc.) Default: eInvoice |
LetterPages | Optional (only for Print channel):Number of pages in letter |
LetterClass | Optional (only for Print channel):The letter class requested. '1' or '2'. Default 2 |
LetterPrintColor | Optional (only for Print channel):If the letter should be printed in color or bw. COLOR/BW. Default BW |
LetterCountry | Optional (only for Print channel):Countryclass where the letter is going. FI/EU/OTHER. Default FI |
...