> For the complete documentation index, see [llms.txt](https://docs.younium.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.younium.com/payments-integrations/aritma.md).

# Aritma

## Overview

Aritma connects Younium to Aritma’s banking and receivables platform for company onboarding, bank statement retrieval, and **import of incoming payments** into Younium payment batches. The integration does not post invoices to Aritma on `InvoicePosted` and is not listed in `IntegrationStartup` workflow actions.

Operational flow: register company → wait for company active → link bank accounts → run import payments job or manual import → payment matching creates batches in Younium.

***

## Authentication

There is nothing to connect and no credentials to enter. Younium reaches Aritma with service credentials held for Younium as a whole, so the connection exists before you configure anything.

What you do instead is register your company with Aritma, which is described below. Until that registration is submitted and Aritma activates the company, the integration is configured but not yet usable.

***

## Activation and disconnect

You register your company with Aritma from the integration settings: Younium sends your organisation details, Aritma creates the company, and the registration is marked as submitted.

Registration is not the same as being active. Aritma activates the company at its end, and Younium refreshes that status when you open the settings — so a company can be registered and still not able to import payments. Onboarding each bank happens through a page Aritma provides, which Younium opens for you.

Disconnecting removes the registration and the bank accounts Younium had recorded for the company, and payment import stops.

***

## Save and setup

No invoice custom fields or `InvoicePosted` subscriptions in Aritma integration code.

***

## Import payments workflow

**Runs when:** the scheduled payment import runs, or an import is started manually.

### Request validation

| Input            | Rule                                          |
| ---------------- | --------------------------------------------- |
| `AccountId`      | Must parse to GUID; Aritma account must exist |
| Company settings | `CompanyId` present; company active           |
| Aritma account   | `IsActive`, has `AccountNumber`               |

### Receivables fetch (Younium → Aritma API)

GET `{ApiUrl}/receivables/{companyId}/{Queued}` with paging (`PageSize` = 100).

Each receivable becomes an incoming payment for matching, carrying its amount, currency, reference and dates.

### Write-back (Younium)

| Aritma / process field | Younium field                                |
| ---------------------- | -------------------------------------------- |
| Import timestamp       | `AritmaAccount.YouniumLastReceivablesImport` |
| Count imported         | `YouniumLastReceivablesImportCount`          |
| Matched payments       | Grouped into payment batches for posting     |

The linked Aritma account records when it was last synchronised, and each run writes a batch log you can review.

### Statements (supporting APIs)

* `GetStatements` / `GetStatementDetails` for bank statement and transaction detail retrieval (used for reconciliation flows).

***

## Field mapping — company registration (Younium → Aritma)

| Younium / request field | Aritma API field     |
| ----------------------- | -------------------- |
| `OrganizationNumber`    | `OrganizationNumber` |
| `Name`                  | `Name`               |
| `Address`               | `Address`            |
| `ZipCode`               | `ZipCode`            |
| `ZipArea`               | `ZipArea`            |
| `Country`               | `Country`            |

Response: company GUID stored as `AritmaSettings.CompanyId`.

***

## Eligibility

* Import only when company registration active.
* Receivables state filter: `AritmaInpaymentState.Queued`.
* Parts of the integration may be enabled or disabled per tenant.

***

## Post invoice workflow

**Not applicable.** No ERP invoice export to Aritma.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.younium.com/payments-integrations/aritma.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.