Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion markdownpages/endpoint/en/hrrelative-post.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Through this endpoint, you create a dossier item (type Family member mutation (Profit) / -41) with a workflow for an employee's manager in InSite. The family member becomes available to the employee when it is approved. The approval can be done through a manual action by the manager, an automatic action in the workflow, or by using the UpdateConnector [`/connectors/KnSubjectWorkflowReaction`](https://docs.afas.help/apidoc/en/Dossiers%2C%20bijlagen%20en%20workflows#post-/connectors/KnSubjectWorkflowReaction)
Through this endpoint, you create a dossier item (type Family member mutation (Profit) / -41) with a workflow for an employee's manager in InSite. The family member becomes available to the employee when it is approved. The approval can be done through a manual action by the manager, an automatic action in the workflow, or by using the UpdateConnector [`/connectors/KnSubjectWorkflowReaction`](../../api-specs/en/Dossiers%2C%20bijlagen%20en%20workflows#post-/connectors/KnSubjectWorkflowReaction)
2 changes: 1 addition & 1 deletion markdownpages/endpoint/nl/hrrelative-post.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Via dit endpoint maak je een dossieritem (type Familielid mutatie (Profit) / -41) met workflow aan voor een leidinggevende van een medewerker in InSite. Het familielid wordt beschikbaar op de medewerker wanneer dit is goedgekeurd. Het goedkeuren hiervan is mogelijk via een handmatige actie van de leidinggevende, automatisch actie in de workflow of het gebruik van UpdateConnector [`/connectors/KnSubjectWorkflowReaction`](https://docs.afas.help/apidoc/nl/Dossiers%2C%20bijlagen%20en%20workflows#post-/connectors/KnSubjectWorkflowReaction)
Via dit endpoint maak je een dossieritem (type Familielid mutatie (Profit) / -41) met workflow aan voor een leidinggevende van een medewerker in InSite. Het familielid wordt beschikbaar op de medewerker wanneer dit is goedgekeurd. Het goedkeuren hiervan is mogelijk via een handmatige actie van de leidinggevende, automatisch actie in de workflow of het gebruik van UpdateConnector [`/connectors/KnSubjectWorkflowReaction`](../../api-specs/nl/Dossiers%2C%20bijlagen%20en%20workflows#post-/connectors/KnSubjectWorkflowReaction)
4 changes: 2 additions & 2 deletions markdownpages/home/en/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ AFAS Software provides software for various organizations and industries. AFAS o

Profit is an ERP solution for all your business processes. The integration of processes plays an important role here. With Profit, you automate everything (well, as much as possible) and you record data only once. Profit is a standard solution with a back-office application, intranet, extranet, and an app. The solution is flexible and provides a solution for many different organizations. To connect with external systems, you use connectors.

[I want to get started with connectors for Profit!](https://docs.afas.help/profit/en/start)
[I want to get started with connectors for Profit!](../profit/en/start)

## SB

AFAS SB is designed for entrepreneurs, startups, and grow-ups. In SB, the entrepreneur and the accountant work together, and maintaining your company accounts is a matter of minutes. SB provides insight and convenience.

[I want to get started with connectors for SB!](https://docs.afas.help/sb/en/Start)
[I want to get started with connectors for SB!](../sb/en/Start)
4 changes: 2 additions & 2 deletions markdownpages/home/nl/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ AFAS Software maakt software voor allerlei organisaties en branches. AFAS biedt

Profit is een ERP-oplossing voor al je bedrijfsprocessen. De integratie van processen neemt hierbij een belangrijke plaats in. Met Profit automatiseer je alles (nou ja, zoveel mogelijk) en je legt gegevens eenmalig vast. Profit is een standaardoplossing met een backoffice-applicatie, intranet, extranet en app. De oplossing is flexibel en biedt een oplossing voor veel verschillende organisaties. Voor koppelingen met externe systemen gebruik je connectoren.

[Ik wil aan de slag met connectoren voor Profit!](https://docs.afas.help/profit)
[Ik wil aan de slag met connectoren voor Profit!](../profit/nl/)

## SB

AFAS SB is de oplossing voor ondernemers, startups en growups. In SB komen de ondernemer en de boekhouder samen en wordt het onderhouden van jouw administratie een kwestie van minuten. SB geeft inzicht en gemak.

[Ik wil aan de slag met connectoren voor SB!](https://docs.afas.help/sb)
[Ik wil aan de slag met connectoren voor SB!](../sb/nl/)
2 changes: 1 addition & 1 deletion markdownpages/main/en/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To use this tooling, you need an environment and API token. Once you have them,

## Postman

Use the AFAS API OpenAPI Specifications directly with Postman. You can [import these specifications into Postman](https://learning.postman.com/docs/integrations/available-integrations/working-with-openAPI/). The OpenAPI Specifications can be downloaded at the top of each API Specification. For example, at [Dossier](https://docs.afas.help/apidoc/en/Organisaties%20en%20personen). Copy this content as described in the Postman documentation.
Use the AFAS API OpenAPI Specifications directly with Postman. You can [import these specifications into Postman](https://learning.postman.com/docs/integrations/available-integrations/working-with-openAPI/). The OpenAPI Specifications can be downloaded at the top of each API Specification. For example, at [Dossier](../../api-specs/en/Organisaties%20en%20personen). Copy this content as described in the Postman documentation.

## RSS feed AFAS Status

Expand Down
2 changes: 1 addition & 1 deletion markdownpages/main/nl/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Om gebruik te maken van deze tooling heb je een omgeving en API token nodig. Hie

## Postman

Gebruik de AFAS API OpenAPI Specificaties direct met Postman. Deze specificatie kan je [inlezen in Postman](https://learning.postman.com/docs/integrations/available-integrations/working-with-openAPI/). De OpenAPI Specificaties kan je downloaden bovenin elke API Specificatie. Bijvoorbeeld bij [Dossier](https://docs.afas.help/apidoc/nl/Organisaties%20en%20personen). Deze content kopieer je zoals beschreven in de Postman documentatie.
Gebruik de AFAS API OpenAPI Specificaties direct met Postman. Deze specificatie kan je [inlezen in Postman](https://learning.postman.com/docs/integrations/available-integrations/working-with-openAPI/). De OpenAPI Specificaties kan je downloaden bovenin elke API Specificatie. Bijvoorbeeld bij [Dossier](../../api-specs/nl/Organisaties%20en%20personen). Deze content kopieer je zoals beschreven in de Postman documentatie.

## RSS feed AFAS Status

Expand Down
8 changes: 4 additions & 4 deletions markdownpages/profit/en/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ author: CLN
date: 2024-06-28
tags: tokens, jwt, bearer, oauth, access
---
The AFAS Profit REST API uses static tokens that you include in the http authentication header of your request. These static tokens are created in the [`App Connector`](https://docs.afas.help/Profit/en/Concepts#app-connector) in Profit. An AFAS administrator with access to the Profit environment can create a token.
The AFAS Profit REST API uses static tokens that you include in the http authentication header of your request. These static tokens are created in the [`App Connector`](./Concepts#app-connector) in Profit. An AFAS administrator with access to the Profit environment can create a token.

> A token is unique to one environment and linked to a user. The permissions of this user will affect the permissions of the token.

Expand Down Expand Up @@ -50,11 +50,11 @@ You will receive a forbidden message when an IP restriction applies to the App C

## Generate token for user via OTP

AFAS offers the option to use a [One Time Password (OTP)](https://docs.afas.help/apidoc/en/Inrichting#post-/OtpRequest) instead of a token. This is useful in situations where users need to register themselves in an application.
AFAS offers the option to use a [One Time Password (OTP)](../../api-specs/en/Inrichting#post-/OtpRequest) instead of a token. This is useful in situations where users need to register themselves in an application.

The OTP option offers a way to retrieve a token without sharing this via an external tool or email for example.

### Read more

- [Profit API GetConnectors](https://docs.afas.help/Profit/en/GetConnector)
- [Error handling](https://docs.afas.help/profit/en/Troubleshooting)
- [Profit API GetConnectors](./GetConnector)
- [Error handling](./Troubleshooting)
4 changes: 2 additions & 2 deletions markdownpages/profit/en/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You invoke the endpoint using the http GET method. To receive new data, you make

## UpdateConnector

An external application can add, modify or delete records in the Profit database via an UpdateConnector (the possibilities vary per endpoint). For each UpdateConnector, a `[metainfo](https://docs.afas.help/apidoc/en/Inrichting#get-/Metainfo/-Type-/-Endpoint-)` request is available. This provides all available fields, including [custom fields / free fields](https://docs.afas.help/Profit/en/Custom%20fields) request. Custom fields are available in this meta information.
An external application can add, modify or delete records in the Profit database via an UpdateConnector (the possibilities vary per endpoint). For each UpdateConnector, a `[metainfo](../../api-specs/en/Inrichting#get-/Metainfo/-Type-/-Endpoint-)` request is available. This provides all available fields, including [custom fields / free fields](./Custom%20fields) request. Custom fields are available in this meta information.

[Detailed documentation about UpdateConnectors](https://help.afas.nl/help/NL/SE/App_Cnr_Rest_Update.htm)

Expand Down Expand Up @@ -63,4 +63,4 @@ This environment is the first environment to receive an update for a new AFAS Pr

### Read more

- [Profit API Authentication](https://docs.afas.help/Profit/en/Authentication)
- [Profit API Authentication](./Authentication)
2 changes: 1 addition & 1 deletion markdownpages/profit/en/get-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Standard GetConnectors are included with Profit, but an administrator can create
- Invoke and test the GetConnector.
- Further validate, edit, etc., the records to be retrieved.

With the GetConnector [`MetaInfo`](https://docs.afas.help/apidoc/en/Organisaties%20en%20personen#get-/MetaInfo), you can request a list of all GetConnectors in an environment. You can invoke this GetConnector via an external application.
With the GetConnector [`MetaInfo`](../../api-specs/en/Organisaties%20en%20personen#get-/MetaInfo), you can request a list of all GetConnectors in an environment. You can invoke this GetConnector via an external application.
Advantages:

- You can see which GetConnectors are available and which ones are blocked.
Expand Down
8 changes: 4 additions & 4 deletions markdownpages/profit/en/howto-bijlage-dossier.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Through the dossier functionality, it is possible to save files as attachments t

## Get dossier items

Endpoint: [ProfitSubjects](https://docs.afas.help/apidoc/en/Dossiers%2C%20bijlagen%20en%20workflows#get-/connectors/ProfitSubjects)
Endpoint: [ProfitSubjects](../../api-specs/en/Dossiers%2C%20bijlagen%20en%20workflows#get-/connectors/ProfitSubjects)

Start by retrieving the dossier items of the type from which you want to retrieve the attachment. You do this with

Expand Down Expand Up @@ -82,7 +82,7 @@ You need the `SbId` in the next step. You can use the rest of the data as metada

## Retrieving attachments from a dossier item

Endpoint: [Profit_Subject_Attachments](https://docs.afas.help/apidoc/en/Dossiers%2C%20bijlagen%20en%20workflows#get-/connectors/Profit_Subject_Attachments)
Endpoint: [Profit_Subject_Attachments](../../api-specs/en/Dossiers%2C%20bijlagen%20en%20workflows#get-/connectors/Profit_Subject_Attachments)

The next step is to retrieve the data of the attachments of the dossier item.

Expand Down Expand Up @@ -116,7 +116,7 @@ From this request, we need:

## Retrieving attachments from reactions to a dossier item

Endpoint: [Profit_Subject_Reaction_Attachments](https://docs.afas.help/apidoc/en/Dossiers%2C%20bijlagen%20en%20workflows#get-/connectors/Profit_Subject_Reaction_Attachments)
Endpoint: [Profit_Subject_Reaction_Attachments](../../api-specs/en/Dossiers%2C%20bijlagen%20en%20workflows#get-/connectors/Profit_Subject_Reaction_Attachments)

`GET https://12345.rest.afas.online/ProfitRestServices/connectors/Profit_Subject_Reaction_Attachments?skip=0&take=100&filterfieldids=subject_id&filtervalues=53955&operatortypes=1`

Expand Down Expand Up @@ -158,7 +158,7 @@ From this request, we need:

## Retrieving a file

Endpoint: [SubjectConnector](https://docs.afas.help/apidoc/en/Dossiers%2C%20bijlagen%20en%20workflows#get-/SubjectConnector). This is a special connector; in the AppConnector you'll find it on the tab Connectors as AppConnectorSubject.
Endpoint: [SubjectConnector](../../api-specs/en/Dossiers%2C%20bijlagen%20en%20workflows#get-/SubjectConnector). This is a special connector; in the AppConnector you'll find it on the tab Connectors as AppConnectorSubject.

Finally, you perform a `foreach` loop over the results of `Profit_Subject_Attachments` and `Profit_Subject_Reaction_Attachments`. With this request, you retrieve the attachment itself.

Expand Down
26 changes: 13 additions & 13 deletions markdownpages/profit/en/howto-finance-mutation-purch.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,54 +23,54 @@ The following endpoints must be called to collect the data before you can create

### Administrations

Endpoint: [Get Administration](https://docs.afas.help/apidoc/en/Mutaties#get-/connectors/Profit_Administrations)
Endpoint: [Get Administration](../../api-specs/en/Mutaties#get-/connectors/Profit_Administrations)

Use the administrationId / `UnId` when creating the financial mutation and the confrontation.

### Journals

Endpoint: [Get Journals](https://docs.afas.help/apidoc/en/Mutaties#get-/connectors/Profit_Journals)
Endpoint: [Get Journals](../../api-specs/en/Mutaties#get-/connectors/Profit_Journals)

Use the journalId / `JoCo` when creating the financial mutation.

### Ledger accounts

Endpoint: [Get Accounts](https://docs.afas.help/apidoc/en/Mutaties#get-/connectors/Profit_Accounts)
Endpoint: [Get Accounts](../../api-specs/en/Mutaties#get-/connectors/Profit_Accounts)

Use the LedgerAccountId / `AcNr` when creating the financial mutation in combination with `"VaAs": "1"`.

### VAT Codes

Endpoint: [Get VAT Code](https://docs.afas.help/apidoc/en/Mutaties#get-/connectors/Profit_VAT_code)
Endpoint: [Get VAT Code](../../api-specs/en/Mutaties#get-/connectors/Profit_VAT_code)

Use the VATCode when creating the financial mutation.

### Creditors

Endpoint: [Get Creditors](https://docs.afas.help/apidoc/en/Mutaties#get-/connectors/Profit_Creditor)
Endpoint: [Get Creditors](../../api-specs/en/Mutaties#get-/connectors/Profit_Creditor)

Use the CreditorId / `CrId` when creating the financial mutation and the receipt. For the financial mutation, fill in `CrId` on field `AcNr` in combination with `"VaAs": "3"`.

### Purchase orders

Create a [custom endpoint](https://docs.afas.help/apidoc/en/Inkoop#get-/connectors/-Endpoint-) for the purchase orders. Make sure to include at least the following fields:
Create a [custom endpoint](../../api-specs/en/Inkoop#get-/connectors/-Endpoint-) for the purchase orders. Make sure to include at least the following fields:

- OrderId / `SoOr`
- ItemId / `ItCd`
- ItemType / `VaIt`
- ItemType / `BiUn`

> Don't know How-To create a GetConnector for this? Then read this [article](https://docs.afas.help/profit/en/GetConnector)
> Don't know How-To create a GetConnector for this? Then read this [article](./GetConnector)

### Warehouses

Endpoint: [Get Warehouses](https://docs.afas.help/apidoc/en/Magazijn#get-/connectors/Profit_Warehouses)
Endpoint: [Get Warehouses](../../api-specs/en/Magazijn#get-/connectors/Profit_Warehouses)

Use the WarehouseId / `War` when creating the receipt.

## Creating goods receipt

Endpoint: [POST /FbGoodsReceived](https://docs.afas.help/apidoc/en/Inkoop#post-/connectors/FbGoodsReceived)
Endpoint: [POST /FbGoodsReceived](../../api-specs/en/Inkoop#post-/connectors/FbGoodsReceived)

Now that you have all the necessary data, you can create the goods receipt. This can be created based on a purchase order / `SoOr`. In addition, you need the purchaseRelationId / `CrId`.

Expand Down Expand Up @@ -114,7 +114,7 @@ The goods receipt has now been created. You must save the `OrNu` for the confron

## Creating financial mutation

Endpoint: [POST FiEntries](https://docs.afas.help/apidoc/en/Mutaties#post-/connectors/FiEntries)
Endpoint: [POST FiEntries](../../api-specs/en/Mutaties#post-/connectors/FiEntries)

The next step is to create the financial mutation. For this you need the data from the previous GET requests.

Expand Down Expand Up @@ -189,12 +189,12 @@ The financial mutation has now been created. You must save the `InId` for the co

Optionally, you now want to do the following:

1. Create an invoice attachment via [KnSubject](https://docs.afas.help/apidoc/en/Dossiers%2C%20bijlagen%20en%20workflows#post-/connectors/KnSubject)
2. Modify the financial invoice that was created via [FiInvoice](https://docs.afas.help/apidoc/en/Mutaties#put-/connectors/FiInvoice)
1. Create an invoice attachment via [KnSubject](../../api-specs/en/Dossiers%2C%20bijlagen%20en%20workflows#post-/connectors/KnSubject)
2. Modify the financial invoice that was created via [FiInvoice](../../api-specs/en/Mutaties#put-/connectors/FiInvoice)

## Creating confrontation

Endpoint: [POST FbConfrontation](https://docs.afas.help/apidoc/en/Mutaties#post-/connectors/FbConfrontation)
Endpoint: [POST FbConfrontation](../../api-specs/en/Mutaties#post-/connectors/FbConfrontation)

The last step is to create the confrontation itself. For this you need the `InId` of the financial mutation and the `OrNu` of the receipt.

Expand Down
Loading