Wisselkoerstype

URL-eindpunt

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/exchangeRateTypes

Versie: v1

Categorie	Metadata Modification
Omschrijving	Wisselkoerstypen ophalen/maken/bijwerken in Adaptive Planning
Vereiste machtigingen voor aanroepen	Valuta's (VALUTA'S)
Vereiste parameters voor aanvraag	N.v.t.

Ondersteunde HTTP-werkwoorden

HTTP-werkwoord	Omschrijving
GET	Hiermee worden alle beschikbare wisselkoerstypen in het systeem opgehaald
GET	Haalt het wisselkoerstype op voor een bepaalde code in het systeem voor de tenant
POST	Op basis van het wisselkoerstype dat beschikbaar is in het systeem, wordt het wisselkoerstype ingevoegd of bijgewerkt.
DELETE	Hiermee wordt het wisselkoerstype verwijderd op basis van de opgegeven wisselkoerstypecode

GET

Aanvraag-URI: /exchangeRateTypes
:
de wisselkoerstypen ophalen.

Haalt alle wisselkoerstypen op die in het systeem voor de tenant beschikbaar zijn.

Voorbeeldaanvraag-URI:

HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/greenco/exchangeRateTypes/A1

POST

Aanvraag:: /exchangeRateTypes
:
hiermee worden de wisselkoerstypen ingevoegd of bijgewerkt.

Hiermee worden de wisselkoerstypen in de planning ingevoegd of bijgewerkt op basis van de wisselkoerstypecode:
Wisselkoerstype invoegen als de code niet in het systeem aanwezig is.
Wordt bijgewerkt of de wisselkoerstypecode al in het systeem aanwezig is.

Voorbeeldaanvraag-URI:

HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/greenco/exchangeRateTypes

Antwoord

204 Geen inhoud

Geslaagd antwoord is leeg met statuscode 204.

Ongeldige aanvraag 400

De aanvraag kan niet worden begrepen door de server.

Voorbeeld

{
    "error": "Errors occurred while processing the request",
    "errors": [
            {
                 "error": "ABCD1 is a duplicate exchange rate type code in the request body. Exchange rate type code must be unique.",
                 "code": "PLN310002"
            },
            {
                 "error": "Abcd name is a duplicate exchange rate type name in the request body. Exchange rate type name must be unique.",
                 "code": "PLN310002"
            },
           {
                 "error": "Test Name is a duplicate exchange rate type name in the request body. Exchange rate type name must be unique.",
                 "code": "PLN310002"
           }
    ]
}

401 Niet geautoriseerd

Gebruiker is niet geautoriseerd.

Voorbeeld:

{ "message": "Invalid credential", "status": 401 }

DELETE

Aanvraag:: /exchangeRateType/{code}
:
hiermee wordt het wisselkoerstype verwijderd.

Hiermee wordt het bestaande door de gebruiker gedefinieerde wisselkoerstype verwijderd. De toewijzing van het externe wisselkoerstype wordt ook verwijderd, indien aanwezig.
De twee gereserveerde wisselkoerstypen kunnen niet worden verwijderd. Dit zijn de wisselkoerstypen 'Maandelijks gemiddelde' en 'Einde van de maand'.

Voorbeeldaanvraag-URI:

HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/greenco/exchangeRateType/Xrate