Skip to end of metadata
Go to start of metadata

  • Payslip API

    • Version 1.15 14.01.2020

    Administrative functions

    AuthenticateByUser

    Returns the associated company information associated by the user if user+password check validates.

    PRODUCTION URL:https://api.apix.fi/authuser?uid=<email>&t=<timestamp>&d=SHA-256:<digest>
    TEST URL:https://test-api.apix.fi/authuser?uid=<email>&t=<timestamp>&d=SHA-256:<digest>

    HTTP Method:
    GET

    Authentication:
    Yes. First SHA-256 digest is calculated from the user password. Then separate SHA-256 digest is calculated from all the parameters and digest version of password is used as the shared secret. The calculated digest is headed by string "SHA-256:".
    See appendix- SHA-256 usage in APIX webservices API

    Parameters:

    <email>

    the userid in the form of email

    <Timestamp>

    the UTC time and date: CCYYMMDDHHMMSS

    <digest>

    SHA-256 digest, calculated from: email+timestamp+PasswordHash

    PasswordHash

    Sha-256 digest of the password.

    Request:
    Only parameters

    Response:
    See 2- Response message structure

    Value types:

    Description

    Ytunnus

    Company's registered company id (Y-tunnus, Org.no)

    Name

    Company name

    AdditionalName

    Additional name

    CustomerNumber

    Internal customer number

    UniqueCompanyID

    Unique company id

    Email

    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

    and for each addresstype found a group:

    AddressType

    Official, Billing, Visiting

    Street1

    Streetname

    Street2

    Streetname

    PostalOffice

    Postal office

    PostalCode

    Postal code

    Country

    Country

    Example:

    Response

    RetrieveTransferID

    Retrieves the system generated TransferID,TransferKey and UniqueCompanyID. The application should store these internally.

    PRODUCTION URL: https://api.apix.fi/app-transferID?id=<company id>&idq=<id qualifier>&uid=<UserID>&ts=<timestamp>&d=SHA-256:<digest>

    TEST URL: https://test-api.apix.fi/app-transferID?id=<company id>&idq=<id qualifier>&uid=<UserID>&ts=<timestamp>&d=SHA-256:<digest>

    HTTP Method:
    GET

    Authentication:
    Yes. First SHA-256 digest is calculated from the user password. Then separate SHA-256 digest is calculated from all the parameters and digest version of password is used as the shared secret. The calculated digest is headed by string "SHA-256:".

    See: ?appendix- SHA-256 usage in APIX webservices API

    Parameters:

    <company id>

    is the official 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>

    qualifier for the identification; y-tunnus, orgnr etc. (usually y-tunnus)

    <uid>

    User ID for the user

    <ts>

    Current timestamp

    <digest>

    SHA-256 digest

    Response:
    See ?2- Response message structure.

    Value types:

    TransferID

    The identification used for sending and receiving

    TransferKey

    The password used for sending and receiving

    UniqueCompanyID

    A unique identifier assigned to the company

    Example:

    RetrieveCompanyInformation

    Retrieves infomation about the registered company; Username, saldos, unique id etc.

    PRODUCTION URL: https://api.apix.fi/getcompanyinfo?TraID=<TransferID>&t=<Timestamp>&d=SHA-256:<digest>

    TEST URL: https://test-api.apix.fi/getcompanyinfo?TraID=<TransferID>&t=<Timestamp>&d=SHA-256:<digest>

    HTTP Method:
    GET

    Authentication:

    Yes. Authentication with SHA-256 digest using the TransferKey as the 'shared secret'.

    See appendix- SHA-256 usage in APIX webservices API

    Parameters:

    TransferID

    The TransferID identifying the owner of the storage

    TimeStamp

    In the format CCYYMMDDHHMMSS. All times are in UTC

    Digest

    The calculated SHA256 digest of the parameters and TransferKey (TRANSFERKEY)

    Response:
    See 2- Response message structure

     

    Sending functions

    SendInvoiceZIP

    Allows sending of a ZIP-file containing one to several invoices (inhouse format) and their corresponding PDF-images (as single files) and optionally also attachments (as single zip-files) to the invoices.

    Note: Usage of this service requires a valid contract of type 'Lähetä'.

    PRODUCTION URL:https://api.apix.fi/invoices?soft=<software>&ver=<version>&TraID=<TransferID>&t=<Timestamp>&d=SHA-256:<digest>
    TEST URL:https://test-api.apix.fi/invoices?soft=<software>&ver=<version>&TraID=<TransferID>&t=<Timestamp>&d=SHA-256:<digest>

    HTTP Method:
    PUT

    Authentication:
    Yes. Authentication with SHA-256 digest using the TransferKey as the 'shared secret'.

    See appendix- SHA-256 usage in APIX webservices API

    Parameters:

    <software>

    the software used to generate the invoice inhouse.

    NOTE: This is the "Interface" name agreed between Apix and the software company

    <version>

    the version of the software used to generate the invoice inhouse.

    NOTE: This is the "Interface" version agreed  between Apix and the software company

    <TransferID>

    the unique TransferID assigned to the customer

     

    <Timestamp>

    the UTC time and date: CCYYMMDDHHMMSS

     

    <digest>

    SHA-256 digest

     

    Response:
    See 2- Response message structure.

    Value types:

    BatchID

    A unique identifier assigned to a batch of documents

    Saldo

    an integer representing the current credit saldo

    CostInCredits

    Total cost of processing in credits

    NetworkedInvoices

    number of Networked einvoices in request/response

    Letters

    number of letters in request/response

    LetterPages

    number of pages of letters in request/response

    RejectedDocument

    number of rejected documents (invoices)

    AcceptedDocument

    number of accepted documents (invoices)

    In addition there can be detailed information about the RejectedDocuments or AcceptedDocuments (one group / document) as follows:

    RejectedDocumentID

    Either document number or position inside the invoice data file

    ValidateText

    Text describing reason for rejection (in english)

    ValidateText:fi

    Optional: Text describing reason for rejection (in finnish)

    ValidateText:sv

    Optional: Text describing reason for rejection (in swedish)

    AcceptedDocumentID

    Document number

    ValidateText

    Additional information about the document processing (in english)

    ValidateText:fi

    Optional: Additional information about the document processing (in finnish)

    ValidateText:sv

    Optional: Additional information about the document processing (in swedish)

    Example:

    HTTP Request
    Response

     

    DeliveryMethod

    Returns the delivery channel and price for individual documents for b2b messages. Contact us if you need the same kind of functionality for b2c messages.
    Note Preferred way is to use DeliveryMethod instead of PricingInfo
    PRODUCTION URL:https://api.apix.fi/method?uid=<TransferID>&t=<timestamp>&d=SHA-256:<digest>
    TEST URL:https://test-api.apix.fi/method?uid=<TransferID>&t=<timestamp>&d=SHA-256:<digest>

    HTTP Method:
    PUT

    Authentication:
    Yes. Authentication with SHA-256 hash (<SHA-256:digest>) using the TransferKey as the 'shared secret'.
    See appendix- SHA-256 usage in APIX webservices API

    Parameters:

    <TransferID>

    the unique TransferID assigned to the customer

    <Timestamp>

    the UTC time and date: CCYYMMDDHHMMSS

    <digest>

    SHA-256 digest

    Request:
    See 1- Request message structure

    Value types:

    DocumentID

    Optional: Document identifier at sender

    SenderName

    Sender's official name

    SenderYtunnus

    Sender's official 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

    Response:

    See 2- Response message structure

    Value types:

    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

    Example:

    Request
    Response

    AddressQuery

    Returns all of the einvoice addresses and operators for given company name and / or businessId. 

    PRODUCTION URL:https://api.apix.fi/addressquery?uid=<TransferID>&t=<timestamp>&d=SHA-256:<digest>
    TEST URL:https://test-api.apix.fi/addressquery?uid=<TransferID>&t=<timestamp>&d=SHA-256:<digest>

    HTTP Method:
    PUT

    Authentication:
    Yes. Authentication with SHA-256 hash (<SHA-256:digest>) using the TransferKey as the 'shared secret'.
    See appendix- SHA-256 usage in APIX webservices API

    Parameters:

    <TransferID>

    the unique TransferID assigned to the customer

    <Timestamp>

    the UTC time and date: CCYYMMDDHHMMSS

    <digest>

    SHA-256 digest

    Request:
    See 1- Request message structure

    Value types:

    ReceiverName

    Receiver's official name, at least one must be defined. Recommended that you don't use this but use only ReceiverYtunnus instead.

    ReceiverYtunnus

    Receiver's BusinessID, at least one must be defined

    Response:

    See 2- Response message structure

    Value types:

    ReceiverName

    Returned if provided in request or found

    ReceiverYtunnus

    Returned if provided in request or found.

    ReceivereInvoiceAddress

    		EInvoice address of receiver, returned if found

    ReceiverOperator

    		Operator of this EInvoiceAddress, returned if found

    Example:

    Request
    Response

     

    SendPrintZIP

    Allows sending of a ZIP-file containing one to several documents in PDF format accompanied with an XML-metadata file. The letters are sent as defined in the agreements (customer settable options in the Apix management www-appliaction).

    Note: Usage of this service requires a valid contract of type 'Lähetä'.

    PRODUCTION URL:https://api.apix.fi/print?soft=<software>&ver=<version>&TraID=<TransferID>&t=<Timestamp>&d=SHA-256:<digest>
    TEST URL:https://test-api.apix.fi/print?soft=<software>&ver=<version>&TraID=<TransferID>&t=<Timestamp>&d=SHA-256:<digest>

    HTTP Method:
    PUT

    Authentication:
    Yes. Authentication with SHA-256 digest using the TransferKey as the 'shared secret'.

    See appendix- SHA-256 usage in APIX webservices API

    Parameters:

    <software>

    the software used to generate the invoice inhouse.

    NOTE: This is the "Interface" name agreed between Apix and the software company

    <version>

    the version of the software used to generate the invoice inhouse.

    NOTE: This is the "Interface" version agreed  between Apix and the software company

    <TransferID>

    the unique TransferID assigned to the customer

     

    <Timestamp>

    the UTC time and date: CCYYMMDDHHMMSS

     

    <digest>

    SHA-256 digest

     

    Response:
    See 2- Response message structure.

    Value types:

    BatchID

    A unique identifier assigned to a batch of documents

    Saldo

    an integer representing the current credit saldo

    CostInCredits

    Total cost of processing in credits

    NetworkedInvoices

    number of letters sent to Netposti

    Letters

    number of letters in request/response

    LetterPages

    number of pages of letters in request/response

    RejectedDocument

    number of rejected documents (invoices)

    AcceptedDocument

    number of accepted documents (invoices)

    In addition there can be detailed information about the RejectedDocuments or AcceptedDocuments (one group / document) as follows:

    RejectedDocumentID

    Either document number or position inside the invoice data file

    ValidateText

    Text describing reason for rejection (in english)

    ValidateText:fi

    Optional: Text describing reason for rejection (in finnish)

    ValidateText:sv

    Optional: Text describing reason for rejection (in swedish)

    AcceptedDocumentID

    Document number

    ValidateText

    Additional information about the document processing (in english)

    ValidateText:fi

    Optional: Additional information about the document processing (in finnish)

    ValidateText:sv

    Optional: Additional information about the document processing (in swedish)

    Metadata:

    Schema file Letters.xsd

     

    Example:

    HTTP Request
    Response

    SendPayslip

    Sends a payslip for delivery. 

    Apix expects to get a ZIP-file with exactly one XML file and at least 1 PDF (the image of the payslip). It is possible to include other pdf files as attachments. XML must contain a reference to all the pdf files. XML is described at https://www.tieke.fi/display/verkkopalkka/PayslipXML_v.2.0. To send other formats, please contact Apix to agree on details.

    Note: Usage of this service requires a valid contract of type 'Lähetä'.

    PRODUCTION URL:https://api.apix.fi/sendpayslip?TraID=<TransferID>&t=<Timestamp>&d=SHA-256:<digest>
    TEST URL:https://test-api.apix.fi/sendpayslip?TraID=<TransferID>&t=<Timestamp>&d=SHA-256:<digest>

    HTTP Method:
    PUT

    Authentication:
    Yes. Authentication with SHA-256 digest using the TransferKey as the 'shared secret'.

    See appendix- SHA-256 usage in APIX webservices API

    Parameters:

    <TransferID>

    the unique TransferID assigned to the customer

     

    <Timestamp>

    the UTC time and date: CCYYMMDDHHMMSS

     

    <digest>

    SHA-256 digest

     

    Response:
    See 2- Response message structure.

    Value types:

    BatchID

    A unique identifier assigned to a batch of documents

    Saldo

    an integer representing the current credit saldo

    CostInCredits

    Total cost of processing in credits

    NetworkedPayslips

    number of letters sent electronically

    Letters

    number of letters in request/response

    LetterPages

    number of pages of letters in request/response

    RejectedDocument

    number of rejected documents (invoices)

    AcceptedDocument

    number of accepted documents (invoices)

    In addition there can be detailed information about the RejectedDocuments or AcceptedDocuments (one group / document) as follows:

    RejectedDocumentID

    Either document number or position inside the invoice data file

    ValidateText

    Text describing reason for rejection (in english)

    ValidateText:fi

    Optional: Text describing reason for rejection (in finnish)

    ValidateText:sv

    Optional: Text describing reason for rejection (in swedish)

    Receiving functions

    Received invoices are kept available for download for 3 calendar months. 

    ReceiveInvoiceZIP

    Note: Usage of this service requires a valid contract of type 'Vastaanota'.

    Note Preferred way is to use list+download instead of ReceivInvoiceZip

    Allows receiving of a ZIP-file containing one invoice (finvoice format) and it's corresponding PDF-image and optionally also attachments (as single zip-file) to the invoice.

    The service will return one invoice at each invocation of the call. If no invoices are present the returned payload is empty. When the invoice is requested it is marked as fetched and will be removed from the service depending on the service agreement with the recipient.

    If the invoice-zip needs to be fetched again an optional <resend> parameter can be added to the request, which gives the invoice last fetched again. If needed a specific invoice can be retrieved regardless of the fetched status by defining the exact documentid for the invoice.

    PRODUCTION URL:https://terminal.apix.fi/receive?TraID=<TransferID>&t=<Timestamp>&soft=<SoftwareName>&ver=<SoftwareVersion>&resend=<resend>&d=SHA-256:<digest>
    TEST URL:https://test-terminal.apix.fi/receive?TraID=<TransferID>&t=<Timestamp>&soft=<SoftwareName>&ver=<SoftwareVersion>&resend=<resend>&d=SHA-256:<digest>

    HTTP Method:
    GET

    Authentication:
    Yes. Authentication with SHA-256 digest using the TransferKey as the 'shared secret'.

    See appendix- SHA-256 usage in APIX webservices API

    Parameters:

    SoftwareName

    The name of using software

    SoftwareVersion

    The version of using software

    TransferID

    The TransferID identifying the owner of the storage

    TimeStamp

    In the format CCYYMMDDHHMMSS. All times are in UTC

    OPTIONAL: <Resend>

    If this parameter is set to '1'. The invoice-zip latest transferred is sent again.

    Digest

    The calculated SHA256 digest of the parameters and TransferKey (TRANSFERKEY). Digest is calculated from: SoftwareName+SoftwareVersion+TransferID+TimeStamp(+Resend)

    Response:

    Example:

    HTTP Request
    Response

    ListInvoiceZIPs

    Note: Usage of this service requires a valid contract of type 'Vastaanota'.

    Allows listing of incoming invoices in the service.

    The service will return list of invoices and the "fetch status" of incoming invoices for current and previous month.

    Information for up to 500 invoices are returned, those already marked to be received are dropped first if more than 500 are found.

     

    PRODUCTION URL:https://terminal.apix.fi/list2?TraID=<TransferID>&t=<Timestamp>&d=SHA-256:<digest>
    TEST URL:https://test-terminal.apix.fi/list2?TraID=<TransferID>&t=<Timestamp>&d=SHA-256:<digest>

    HTTP Method:
    GET

    Authentication:
    Yes. Authentication with SHA-256 digest using the TransferKey as the 'shared secret'.

    See appendix- SHA-256 usage in APIX webservices API

    Parameters:

    TransferID

    The TransferID identifying the owner of the storage

    TimeStamp

    In the format CCYYMMDDHHMMSS. All times are in UTC

    Digest

    The calculated SHA256 digest of the parameters and TransferKey (TRANSFERKEY)

    Response:
    See 2- Response message structure

    Value types:

    StorageId

    Id of the storage

    Status

    Received or Unreceived

     

    List2 StorageStatus/Transferstatus explanation

    StorageStatusTransferStatusExplanation
    NEW Still being created, do not fetch
    UNRECEIVEDNEWReady to be fetched
    RECEIVEDRETRIEVEDFetched at least once
    DELETED Scheduled to be removed

     

    Example:

    HTTP Request
    Response

    ListInvoiceZIP2ForDate

    Works as ListInvoiceZIP2 but searches for certain date, disregards status, and has no limit

    Note: Usage of this service requires a valid contract of type 'Vastaanota'.

    The service will return invoices for certain date.

    PRODUCTION URL:https://terminal.apix.fi/list2fordate?TraID=<TransferID>&date=<Date>&t=<Timestamp>&d=SHA-256:<digest>
    TEST URL:https://test-terminal.apix.fi/list2fordate?TraID=<TransferID>&date=<Date>&t=<Timestamp>&d=SHA-256:<digest>

    HTTP Method:
    GET

    Authentication:
    Yes. Authentication with SHA-256 digest using the TransferKey as the 'shared secret'.

    See appendix- SHA-256 usage in APIX webservices API

    Parameters:

    TransferID

    The TransferID identifying the owner of the storage

    TimeStamp

    In the format CCYYMMDDHHMMSS. All times are in UTC

    Digest

    The calculated SHA256 digest of the parameters and TransferKey (TRANSFERKEY)

    DateDate in format of yyyy-MM-dd

     


    Response:

    See 2- Response message structure

    Value types:

    StorageId

    Id of the storage

    Status

    Received or Unreceived

    Example:

    HTTP Request

     

    GET /list2fordate?TraID=e4fb42c4-2e72-4e8c-80aa-3724e402c0a8&date=2010-06-05&t=20100605123412&d=SHA-256:398217e7a83e4e88fcc839b4566f7c897a1f8f09dffc8479513ffe26c6a3fb1a

     

    SetReceiveEmail

    Note: Usage of this service requires a valid contract of type 'Vastaanota'.

    Sets the email-address for sending the received invoices.

    PRODUCTION URL:https://api.apix.fi/email?uid=<TransferID>&t=<timestamp>&d=SHA-256:<digest>
    TEST URL:https://test-api.apix.fi/email?uid=<TransferID>&t=<timestamp>&d=SHA-256:<digest>

    HTTP Method:
    PUT

    Authentication:
    Yes. Authentication with SHA-256 hash (<SHA-256:digest>) using the TransferKey as the 'shared secret'.
    See appendix- SHA-256 usage in APIX webservices API

    Parameters:

    <TransferID>

    the unique TransferID assigned to the customer

    <Timestamp>

    the UTC time and date: CCYYMMDDHHMMSS

    <digest>

    SHA-256 digest

    Request:
    See 1- Request message structure

    Value types:

    Email

    Valid email address for receiving the invoices. If empty - the default address given at registration time is used

    DaysBeforeEmail

    0-5. Where 0 means; do not send email (DEFAULT) and 1 means the same day, 2 next day and so on.

    Response:
    See 2- Response message structure

    Value types:

    PreviousEmail

    The email used before the call

    Example:

    Request
    Response

    Download

     

    AUTHENTICATION for Download is through StorageID and StorageKEY.

     

    Retrieves the requested files from the storage - if no file defined returns all UNLOCKED files from the specified storage as zip-file. The return value is the contents of the file.

    URL: https://terminal.apix.fi/download?SID=<StorageID>&t=TimeStamp&d=SHA-256:<Digest>

    URL TEST: https://test-terminal.apix.fi/download?SID=<StorageID>&t=TimeStamp&d=SHA-256:<Digest>

    HTTP Method:
    GET

    Returns contents of the whole storage with attachments. 
    Authentication:
    Yes. The separate SHA-256 digest is calculated from all the parameters and addition with the StorageKey as the shared secret. The calculated digest is headed by string "SHA-256:".

    Digest is calculated from: (MarkReceived+) StorageID+TimeStamp+StorageKey

     

    Parameters:

    MarkReceived

    Optional parameter. Using this the storage status is marked as 'Received' when downloaded. Valid values are: 'markreceived=yes' and 'markreceived=no'.

    If this is not used and get request is done to receive whole storage, it is marked as received.

    StorageID

    The storageid to download the file from

    TimeStamp

    In the format CCYYMMDDHHMMSS. All times are in UTC

    Digest

    The calculated SHA256 digest of the parameters and storagekey (KEY)

    Example:

    Response:
    The requested file as payload in HTTP response body.

    or in case of error (Wrong key, or storageid) nothing. Other errors returned at HTTP-response level.

    GetMetadata

    Returns all stored metadata for given storage and all the files stored inside it.

    URL: https://terminal.apix.fi/metadata?TraID=<TransferID>&SID=<StorageID>&t=<Timestamp>&d=SHA-256:<digest>
    URL TEST: https://test-terminal.apix.fi/metadata?TraID=<TransferID>&SID=<StorageID>&t=<Timestamp>&d=SHA-256:<digest>
    HTTP Method:
    GET
    Authentication:
    Yes. The separate SHA-256 digest is calculated from all the parameters and addition with the TransferKey password as the shared secret. The calculated digest is headed by string "SHA-256:".

    Digest is calculated from: StorageID+TransferID+Timestamp+TransferKey
    Parameters:

    TransferID

    The TransferID identifying the owner of the storage

    StorageID

    The storageid to lock the file in

    TimeStamp

    In the format CCYYMMDDHHMMSS. All times are in UTC

    Digest

    The calculated SHA256 digest of the parameters and TransferKey (TRANSFERKEY)

    Request:
    See: Request- TERMINAL

    Value types:

    Response:
    See: Response- TERMINAL

    Value types:

    FileName

    Filename

    Example:

    Request

     

     

     

    Response

     

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <Response>
      <Status>OK</Status>
      <StatusCode>2A00</StatusCode>
      <Content>
        <Group>
          <Value type="email">uusi-email</Value>
          <Value type="saaaa">t&#xE4;h&#xE4;n jotain ylim&#xE4;&#xE4;r&#xE4;ist&#xE4; informaatiota</Value>
        </Group>
        <Group>
          <Value type="FileName">Lasku 1196.pdf</Value>
          <Value type="email">tannelahtee@apix.fi</Value>
        </Group>
      </Content>
    </Response>

     

    Accounting functions

    GetSaldo

    Retrieves the company's current credit saldo (amount of netstamps)

    PRODUCTION URL:https://api.apix.fi/saldo?id=<company-unique-id>
    TEST URL:https://test-api.apix.fi/saldo?id=<company-unique-id>

    HTTP Method:
    GET

    Authentication:
    No.

    Parameters:

    <company-unique-id>

    the system assigned unique-id for the company.

    Response:
    See ?2- Response message structure.

    Value types:

    Saldo

    a decimal representing the current credit saldo

    Example:

    GetUsedSaldo

    Retrieves the total amount of used credits for a company

    PRODUCTION URL:https://api.apix.fi/usedsaldo?id=<company-unique-id>
    TEST URL:https://test-api.apix.fi/usedsaldo?id=<company-unique-id>

    HTTP Method:
    GET

    Authentication:
    No.

    Parameters:

    <company-unique-id>

    the system assigned unique-id for the company.

    Response:
    See ?2- Response message structure.

    Value types:

    UsedSaldo

    a decimal representing the total used credits

    Example:

    Payslip API

     

    Delete

    Delete requested payslip

     

    URL: https://terminal.apix.fi/senderpayslip?TraID=<TransferID>&t=TimeStamp&hash=<ReceiverHash>&date=<DateID>&D=SHA-256:<Digest>
    HTTP Method:
    DELETE
    Authentication:
    Yes. The separate SHA-256 digest is calculated from all the parameters and addition with the TransferKey as the shared secret. The calculated digest is headed by string "SHA-256:".

    Parameters:

    TraIDUser transfer ID
    TimeStamp

    In the format CCYYMMDDHHMMSS. All times are in UTC

    ReceiverHashMD5 hex value of person id  
    DateIDPayslip date in the format of YYYYMMDD and payslip ID separated with "-" example: 20200515-7645849
    DigestThe calculated SHA256 digest of the parameters and transferKey (TraID+ReceiverHash+DateID+TimeStamp+Tkey)
      

    Example:

     

    Response on succesful delete:

     

     

     

    • No labels