Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
xml
xml
titleResponse
 

<Response>
  <Status>OK</Status>
  <StatusCode>2700</StatusCode>
  <Content>
    <Group>
      <Value type="DocumentID">1371</Value>
      <Value type="DueDate">20150401</Value>
      <Value type="SellerReference">N/A</Value>
      <Value type="SenderVAT">104351234-6</Value>
      <Value type="DocumentDate">20150322</Value>
      <Value type="PaymentStatus">NOTPAID</Value>
      <Value type="PaymentReference">1180050173</Value>
      <Value type="SenderName">Testi Ohjelmat Oy</Value>
      <Value type="TransferStatus">NEW</Value>
      <Value type="ReceiverVAT">N/A</Value>
      <Value type="DocumentName">invoice.xml</Value>
      <Value type="ImageName">Lasku 1183.pdf</Value>
      <Value type="AmountToPay">122.88</Value>
      <Value type="ReceiverId">123451-2</Value>
      <Value type="CreatedDate">20150323</Value>
      <Value type="ApprovalStatus">NEUTRAL</Value>
      <Value type="BankAccount">FI8529501800020574</Value>
      <Value type="OrderReference">N/A</Value>
      <Value type="Currency">EUR</Value>
      <Value type="ReceiverName">Test Receiver</Value>
      <Value type="StorageKey">185629244874</Value>
      <Value type="StorageID">51974e79-feef-adsaf-b543-43adsf0fca</Value>
      <Value type="StorageStatus">UNRECEIVED</Value>
      <Value type="DocumentOrigin">eInvoice</Value>
    </Group>
</Content>
</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'.

...