Versions Compared

Key

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

...

Code Block
xml
xml
titleResponse
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response version="1.0">
     <Status>OK</Status>
     <StatusCode>1000</StatusCode>
     <FreeText language="en">OK</FreeText>
     <Content>
        <Group>
		<Value type="BatchID">1633b003-0315-44ca-a687-a25f92bf6123</Value>
		<Value type="Saldo">199</Value>
		<Value type="CostInCredits">1</Value>
		<Value type="NetworkedInvoices">0</Value>
		<Value type="Letters">1</Value>
		<Value type="LetterPages">2</Value>
		<Value type="AcceptedDocument">1</Value>
        </Group>
        <Group>
                <Value type="AcceptedDocumentID">1001</Value>
                <Value type="ValidateText">Document InvoiceID OK</Value>
        </Group>
     </Content>
</Response>

Resend

Resends original zip to original channel or selected one. Removes duplicate check.

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

PRODUCTION URL:https://api.apix.fi/resend?channel=<channel>&ver=<version>&messageId=<uniqueMessageId>&TraID=<TransferID>&t=<Timestamp>&d=SHA-256:<digest>
TEST URL:https://test-api.apix.fi/resend?channel=<channel>&ver=<version>&messageId=<uniqueMessageId>&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:

 

<channel>the software used to generate the invoice inhouse. OPTIONAL
<version>the version of the software used to generate the invoice inhouse. OPTIONAL
<uniqueMessageId>ID for message to be resend
<TransferID>the unique TransferID assigned to the customer
<Timestamp>the UTC time and date: CCYYMMDDHHMMSS
<digest>SHA-256 digest (channel+version+)uniqueMessageId+TransferId+Timestamp+secret

 

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:

Code Block
titleHTTP Request
PUT /resend?messageId=47381702-9999-4bae-8888-c66c85cdf26d&TraID=58748296-7777-8888-9999-8405a31a3d33&t=20210304065306&d=SHA-256%3A7cb8861b417bf068335e92d0d575475fa3b78925eed677e94ee8ae447fdbba58
 HTTP/1.1
Content-Type: application/json

...

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response version="1.0">
     <Status>OK</Status>
     <StatusCode>1000</StatusCode>
     <FreeText language="en">OK</FreeText>
     <Content>
        <Group>
		<Value type="BatchID">1633b003-0315-44ca-a687-a25f92bf6123</Value>
		<Value type="Saldo">199</Value>
		<Value type="CostInCredits">1</Value>
		<Value type="NetworkedInvoices">1</Value>
		<Value type="Letters">0</Value>
		<Value type="LetterPages">0</Value>
		<Value type="AcceptedDocument">1</Value>
        </Group>
        <Group>
                <Value type="AcceptedDocumentID">1001</Value>
                <Value type="ValidateText">OK</Value>
        </Group>
     </Content>
</Response>

 

SendPayslip

Sends a payslip for delivery. 

...