Overview

Document API

The PEAX Document Partner Microservice API serves as a vital conduit for managing document exchanges between PEAX-Core and its partners. This API facilitates a streamlined process whereby documents are initially sent from PEAX-Core to the Partner Document Service via webhook notifications. Partners are then empowered to query metadata and document content, ensuring they have comprehensive access to document details necessary for their operations.

Upon successful retrieval of documents from the Partner Document API, partners are required to call the "confirm" API endpoint to acknowledge the completion of document retrieval. This step is crucial for maintaining the integrity and tracking of document processing within the ecosystem.

Additionally, the "inventory" API offers partners the ability to fetch a list of documents that have not yet been retrieved. This functionality ensures that no document is overlooked and that partners have a complete overview of all documents pending retrieval, enhancing the efficiency and reliability of document management.

PEAX-Core initiates the process by sending documents to the Partner Document Service via webhook notifications.

Partners interact with the service to query metadata and document content for detailed information.

Partners are required to confirm the successful retrieval of each document through the API, signaling that the document has been processed or reviewed.

The Inventory API allows partners to check for pending documents, ensuring all documents are accounted for and retrieved in a timely manner.

This architecture underscores the API's role in facilitating efficient document exchange and management between PEAX-Core and its partners, enhancing the operational workflow and document traceability within the ecosystem.

Domain Model

The Document class is central, linking to other classes that represent detailed information about orders, addresses, legal entities involved, payment details, tax details, and VAT details.

Type Definitions

Type	Type Value	Description
DocumentStatusType	NONE	No document has been delivered.
	DELIVERED	Document has been delivered and is visible in PEAX.
	DELETED	Document has been moved to recycle bin.
	PURGED	Document has been permanently deleted.
	RESTORED	Document has been restored from recycle bin.
Payment Type	ORANGE_PAYMENT_SLIP	Orange payment slip (can no longer be paid in PEAX)
	RED_PAYMENT_SLIP	Red payment slip (can no longer be paid in PEAX)
	QR	QR invoices
	OTHER	Invoices with type ‘BDD/LSV’ that are automatically paid via debit direct and are automatically moved to the paid invoices (section), upon reaching the due date.
PaymentRecordType	NONE	There is no payment record for this invoice.
	PENDING	Payment has been initiated but not yet executed.
	PAID	The payment has been successfully transferred to and received by the payment system. Payment executed.
	REJECTED_DUE_INSUFFICIENT_BALANCE	This status is applied if a payment could not be executed due to insufficient credit and the number of payment attempts - defined in the settings - has been reached.
	REJECTED_BY_BANK	This status is very rare. It only occurs if a single payment is not valid and the bank rejects it.
	CANCELLED	Means it’s a storno. When the receiving bank could not assign the payment to any of its customers and returned the money, PEAX books a Storno for this payment.
	DELETED	If the user cancels the payment order, this will change the status of the payment record to DELETED.
PaymentStatusType	OPEN	Invoice that is open and located in the open invoices (section).
	PENDING	Invoice which is pending and accordingly is in the pending invoices (section). The execution date is in the future.
	PAID	Invoice that is paid and accordingly is in the paid invoices (section). The execution date is today or in the past and the storno-flag is false.
PaymentMethodType	TRANSACTION_ACCOUNT	The invoice was settled with credit on the transaction account.
	BANK_ACCOUNT	The invoice was settled via bank account (LSV/BDD).
	PRE_PAYMENT	The invoice is paid by prepayment(). The user must transfer the money to the transaction account so that the invoice can be paid on time.(if no or not sufficient credit is on the transaction account)
	OBSOLETE	The invoice is marked as done with reasoning ‘void’, as it does not need to be paid anymore. The invoice gets moved to the section ‘paid invoices’.
	SETTLED	The invoice is marked as done with reasoning ‘already paid’, as it was already paid outside PEAX. The invoice gets moved to the section ‘paid invoices’.

Process Model

PEAX-Core initiates the process by sending a document notification via a Webhook.

The Webhook Notification system forwards this notification to the Partner.

The Partner, upon receiving the notification, queries the Document Partner API for the document's metadata.

The Document Partner API then fetches this metadata from PEAX-Core and returns it to the Partner.

For document content, the Partner requests the content from the Document Partner API, which in turn retrieves it from PEAX-Core and delivers it to the Partner.

After reviewing or processing the document, the Partner confirms the document's retrieval through the Document Partner API, which then marks the document as retrieved in PEAX-Core.

Additionally, the Partner can query the inventory for any pending documents via the Document Partner API, which requests and returns this inventory list from PEAX-Core.

Linking Endpoints

The partner can initiate the onboarding over the linking endpoints. Check the API Create Linking.

Document API#

Domain Model#

Type Definitions#

Process Model#

Linking Endpoints#

Document API

Domain Model

Type Definitions

Process Model

Linking Endpoints