Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 12 additions & 23 deletions .github/workflows/markdown-naming-check.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
name: Markdown Naming Convention Check

# Trigger the workflow on push and pull request events
on:
push:
branches:
Expand Down Expand Up @@ -28,12 +27,11 @@ jobs:
runs-on: ubuntu-latest

steps:
# Checkout the repository code
- name: Checkout repository
uses: actions/checkout@v4
with:
# Fetch full history for better file analysis
fetch-depth: 0
fetch-depth: 0

# Set up Python environment
- name: Set up Python
Expand All @@ -42,32 +40,23 @@ jobs:
python-version: '3.9'
cache: 'pip'

# Install dependencies (if any are added in the future)
# Install dependencies
- name: Install dependencies
run: |
python -m pip install --upgrade pip
# Add any future dependencies here
# pip install -r requirements.txt
shell: bash

pip install python-frontmatter PyYAML

# Make the validation script executable
- name: Make script executable
run: chmod +x scripts/markdown-naming-check.py
shell: bash

# Run the markdown naming validation
- name: Run markdown naming validation
id: validation
id: validate
run: |
echo "Starting markdown file naming validation..."
# Check if markdownpages directory exists
if [ -d "markdownpages" ]; then
python scripts/markdown-naming-check.py --root-path markdownpages
else
echo "No markdownpages directory found!"
exit 1
fi
shell: bash
python scripts/markdown-naming-check.py --root-path markdownpages
continue-on-error: true

# Generate detailed report for PR comments (if needed)
Expand All @@ -79,18 +68,18 @@ jobs:

# Run the validation and capture both exit code and output
set +e # Temporarily disable exit on error

# Check which directory exists and run validation accordingly
if [ -d "markdownpages" ]; then
python scripts/markdown-naming-check.py --root-path markdownpages --json > validation-report.json
else
echo '{"error": "No markdownpages directory found", "success": false, "total_files_checked": 0, "violations_found": 0, "violations": []}' > validation-report.json
validation_exit_code=1
fi

validation_exit_code=$?
set -e # Re-enable exit on error

# Check if there are violations based on exit code
if [ $validation_exit_code -eq 0 ]; then
echo "validation_status=success" >> $GITHUB_OUTPUT
Expand All @@ -105,7 +94,7 @@ jobs:
echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
fi
shell: bash

# Upload validation report as artifact
- name: Upload validation report
if: always()
Expand Down Expand Up @@ -169,4 +158,4 @@ jobs:
else
echo "- **Status:** ❌ Validation report not found" >> $GITHUB_STEP_SUMMARY
fi
shell: bash
shell: bash
13 changes: 13 additions & 0 deletions API-Documentation.code-workspace
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"folders": [
{
"name": "API-Documentation",
"path": "../API-Documentation"
},
{
"name": "OASContent",
"path": "."
}
],
"settings": {}
}
8 changes: 4 additions & 4 deletions markdownpages/profit/en/app-connector-auditor-afas.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Partner Integration Self Service for AFAS employees
author: Eric Zwaal
date: 2025-09-06
tags: Appconnector, setup, GetConnector
date: 2025-11-08
index: false
tags: Partner, Integration, Hr
title: Partner Integration Self Service for AFAS employees
---

Dit bestand is niet beschikbaar in het Engels. Lees de [Nederlandse versie](../nl/app-connector-auditor-afas).
Dit bestand is niet beschikbaar in het Engels. Lees de [Nederlandse versie](../nl/app-connector-auditor-afas).
8 changes: 4 additions & 4 deletions markdownpages/profit/en/app-connector-auditor-partner.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: AppConnector Auditor for Partners
author: Eric Zwaal
date: 2025-09-16
tags: Appconnector, setup, GetConnector
date: 2025-11-08
index: true
tags: Partner, IntegrationId, Tutorial, GetConnector, UpdateConnector, Profit5
title: AppConnector Auditor for Partners
---

*this file is an AI-translated version of the [Dutch document](../nl/app-connector-auditor-afas) and may contain errors.*
Expand Down Expand Up @@ -310,4 +310,4 @@ Do you have questions, comments, bug reports, suggestions for improvement, compl

###### Don't have a login?

One or more of your colleagues are administrators on the customer portal and can add you as a contact, so you can log in yourself.
One or more of your colleagues are administrators on the customer portal and can add you as a contact, so you can log in yourself.
9 changes: 4 additions & 5 deletions markdownpages/profit/en/app-connector-auditor.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: AppConnector Auditor
author: Eric Zwaal
date: 2025-09-16
tags: Appconnector, setup, GetConnector, authorization
date: 2025-11-08
index: true
tags: Partner, GetConnector, UpdateConnector, AppConnector, Integration, Configuration
title: AppConnector Auditor
---

*this document is an AI-translated version of the [Dutch documentation](../nl/app-connector-auditor) and may contain errors.*
Expand Down Expand Up @@ -178,5 +178,4 @@ See [above](#there-are-getconnectors-with-more-than-10-joins). This GetConnector

#### This GetConnector retrieves data from tables more than 5 levels deep

See [above](#there-are-getconnectors-that-retrieve-data-more-than-5-levels-deep). This GetConnector may be optimized if you experience performance issues with the integration.

See [above](#there-are-getconnectors-that-retrieve-data-more-than-5-levels-deep). This GetConnector may be optimized if you experience performance issues with the integration.
6 changes: 3 additions & 3 deletions markdownpages/profit/en/authentication.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Authentication
author: CLN
date: 2024-06-28
tags: tokens, jwt, bearer, oauth, access
date: 2025-11-08
tags: Tutorial, GetConnector, UpdateConnector, AppConnector, Integration, Configuration
title: Authentication
---

## Introduction
Expand Down
9 changes: 5 additions & 4 deletions markdownpages/profit/en/concepts.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Concepts
author: CLN
date: 2024-05-28
tags: Appconnector, GetConnector, UpdateConnector
date: 2025-11-08
tags: GetConnector, UpdateConnector, AppConnector, Configuration, Authentication, Authorization
title: Concepts
---

## App Connector

The App Connector is the component in AFAS Profit through which you can integrate your App. The AFAS administrator sets it up in several steps. The App Connectors authorize GetConnectors and UpdateConnectors, and the administrator creates the token here. Profit administrators can add an unlimited number of App Connectors.
Expand Down Expand Up @@ -63,4 +64,4 @@ This environment is the first environment to receive an update for a new AFAS Pr

### Read more

- [Profit API Authentication](./authentication)
- [Profit API Authentication](./authentication)
8 changes: 4 additions & 4 deletions markdownpages/profit/en/custom-fields.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Custom Fields
author: CLN
date: 2024-05-28
tags: custom, customfields, custom fields, guids
date: 2025-11-08
tags: GetConnector, UpdateConnector, Configuration
title: Custom Fields
---

AFAS administrators can add custom fields (vrije velden) to most tables in Profit. These custom fields will then become available in the endpoints.
Expand Down Expand Up @@ -73,4 +73,4 @@ curl -X PUT "https://12345.rest.afas.online/ProfitRestServices/connectors/KnPers
AFAS administrators have the option to add custom fields in the environment.

- [Configuration](https://help.afas.nl/help/NL/SE/App_UDF_Field_Add.htm)
- [Exchange between environments](https://help.afas.nl/help/NL/SE/App_UDF_ExpImp.htm)
- [Exchange between environments](https://help.afas.nl/help/NL/SE/App_UDF_ExpImp.htm)
9 changes: 5 additions & 4 deletions markdownpages/profit/en/get-connector-geblokkeerd.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: GetConnector blocked
author: EZW
date: 2024-07-22
tags: GetConnector, troubleshoot
date: 2025-11-08
tags: GetConnector, Integration, Crm
title: GetConnector blocked
---

Have you received a message that a GetConnector in your environment has been blocked? Then this article is for you.

AFAS maintains a Fair Use policy for API usage. In practice, this means that every day the 10 heaviest users receive a message that they need to adjust their process.
Expand All @@ -24,4 +25,4 @@ A GetConnector is always called by another process; this is often an external ap
## Unblock the GetConnector

Once the problem is solved, you can unblock the GetConnector. You unblock a GetConnector via the following path: **General / Output / Management / GetConnector**. Then choose the action **Definition**. With this action you open the properties of the GetConnector. You uncheck the **Blocked** field. Are the blocked rows not visible in the view? Then click the gear wheel at the top right and click **Show blocked rows**.
*source: https://help.afas.nl/meldingen/NL/SE/99797.htm*
*source: https://help.afas.nl/meldingen/NL/SE/99797.htm*
8 changes: 4 additions & 4 deletions markdownpages/profit/en/get-connector.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: GetConnector
author: CLN
date: 2024-12-17
tags: get, data, sorting
date: 2025-11-08
tags: GetConnector, AppConnector, Integration, Authorization, Hr, Order Management
title: GetConnector
---

A GetConnector is an endpoint that allows an application to retrieve records from the Profit database. An AFAS administrator can compose these GetConnector definitions themselves, determining the records and fields that can be retrieved.
Expand Down Expand Up @@ -273,4 +273,4 @@ Response:

## Rowcount on GetConnector

To get a rowcount on a GetConnector, you need to create a copy of the existing GetConnector. Based on this, you can add an aggregation on the key and make the other fields invisible. Request the AFAS administrator to carry this out. [Functional description](https://help.afas.nl/help/NL/SE/App_Query_Cond.htm)
To get a rowcount on a GetConnector, you need to create a copy of the existing GetConnector. Based on this, you can add an aggregation on the key and make the other fields invisible. Request the AFAS administrator to carry this out. [Functional description](https://help.afas.nl/help/NL/SE/App_Query_Cond.htm)
8 changes: 4 additions & 4 deletions markdownpages/profit/en/howto-ats.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Onboarding a new candidate
author: EZW
date: 2025-09-02
tags: candidate, flex, front, back, office
date: 2025-11-08
tags: Tutorial, GetConnector, UpdateConnector, Profit4, Configuration, Authorization
title: Onboarding a new candidate
---

## Introduction
Expand Down Expand Up @@ -294,4 +294,4 @@ The field `VcSn` / Vacancy sequence number must match the vacancy being applied
}
```

The call to `HrCreateApplicant` creates a dossier item of the type "Application" (code -44). For this dossier item, the `CaId` value from the previous response is used for the destination `Create application`. Use that information to retrieve the number of the dossier item via a custom GetConnector if you need it.
The call to `HrCreateApplicant` creates a dossier item of the type "Application" (code -44). For this dossier item, the `CaId` value from the previous response is used for the destination `Create application`. Use that information to retrieve the number of the dossier item via a custom GetConnector if you need it.
8 changes: 4 additions & 4 deletions markdownpages/profit/en/howto-bijlage-dossier.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Retrieving attachments from AFAS Profit
author: CLN
date: 2024-04-27
tags: attachment, appendix, pdf, payslip, annual statement
date: 2025-11-08
tags: Tutorial, GetConnector, UpdateConnector, AppConnector, Authentication, Authorization
title: Retrieving attachments from AFAS Profit
---

## Introduction
Expand Down Expand Up @@ -183,4 +183,4 @@ This request contains filters:

### Finally

You have now gone through all the components needed to retrieve attachments from AFAS. If you have a question about this, post it on the forum of [AFAS Connect](https://connect.afas.nl/forum). The community is happy to help you further!
You have now gone through all the components needed to retrieve attachments from AFAS. If you have a question about this, post it on the forum of [AFAS Connect](https://connect.afas.nl/forum). The community is happy to help you further!
8 changes: 4 additions & 4 deletions markdownpages/profit/en/howto-finance-mutation-purch.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Financial mutations purchasing
author: CLN
date: 2024-04-04
tags: purchasing, confrontation, purchase invoice
date: 2025-11-08
tags: Tutorial, GetConnector, UpdateConnector, Integration, Authentication, Finance
title: Financial mutations purchasing
---

## Introduction
Expand Down Expand Up @@ -247,4 +247,4 @@ The last step is to create the confrontation itself. For this you need the `InId
"CfSt": "2"
}
}
```
```
8 changes: 4 additions & 4 deletions markdownpages/profit/en/howto-finance-mutation.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Financial mutations basics
author: CLN
date: 2024-10-28
tags: Financial, mutations, accounting
date: 2025-11-08
tags: Tutorial, GetConnector, UpdateConnector, Integration, Authentication, Finance
title: Financial mutations basics
---

## Introduction
Expand Down Expand Up @@ -381,4 +381,4 @@ In some situations, you may want to edit the financial invoice, which is automat
}
}
}
}
}
8 changes: 4 additions & 4 deletions markdownpages/profit/en/howto-flex.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Sales relation and customer agreement - flex
author: CLN
date: 2024-03-04
tags: sales, customer, agreement, flex
date: 2025-11-08
tags: Tutorial, GetConnector, UpdateConnector, Configuration, Authorization, Finance
title: Sales relation and customer agreement - flex
---

## Introduction
Expand Down Expand Up @@ -142,4 +142,4 @@ Example request:
}
}
```
a
a
Binary file modified markdownpages/profit/en/howto-la-sa.md
Binary file not shown.
6 changes: 3 additions & 3 deletions markdownpages/profit/en/howto-medewerker-ad.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Employee synchronization with Active Directory
author: CLN
date: 2024-03-06
tags: AD, Active Directory, employee onboarding, employee offboarding
date: 2025-11-08
tags: Tutorial, GetConnector, UpdateConnector, Authentication, Authorization, Hr
title: Employee synchronization with Active Directory
---

## Introduction
Expand Down
8 changes: 4 additions & 4 deletions markdownpages/profit/en/howto-mobility.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Transport Vehicle for Employee
author: CLN
date: 2024-04-04
tags: car, bicycle, transport, mobility
date: 2025-11-08
tags: Tutorial, GetConnector, UpdateConnector, Integration, Configuration, Authentication
title: Transport Vehicle for Employee
---

## Introduction
Expand Down Expand Up @@ -190,4 +190,4 @@ Finally, optionally create a file item with, for example, the lease agreement in
}
}
}
```
```
Loading