Tipo de taxa cambial

Ponto de extremidade de URL

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

Versão: v1

Categoria	Modificação de metadados
Descrição	Obter/criar/atualizar tipos de taxa cambial no Adaptive Planning
Permissões obrigatórias para invocar	Moedas (MOEDAS)
Parâmetros obrigatórios na solicitação	N/A

Verbos HTTP com suporte

Verbo HTTP	Descrição
GET	Recupera todos os tipos de taxa cambial disponíveis no sistema
GET	Recupera o tipo de taxa cambial para um determinado código no sistema para o locatário
POST	Com base no tipo de taxa cambial disponível no sistema, ele insere/atualiza o tipo de taxa cambial.
DELETE	Exclui o tipo de taxa cambial com base no código de tipo de taxa cambial fornecido

GET

Solicitar URI: /exchangeRateTypes
:
busca os tipos de taxa cambial.

Busca todos os tipos de taxa cambial disponíveis no sistema para o locatário.

Exemplo de URI de solicitação:

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

POST

Solicitação: /exchangeRateTypes
:
insere ou atualiza os tipos de taxa cambial.

Insere ou atualiza os tipos de taxa cambial no Planning com base no código de tipo de taxa cambial:
Insira o tipo de taxa cambial se o código não estiver presente no sistema.
Atualiza se o código de tipo de taxa cambial já está presente no sistema.

Exemplo de URI de solicitação:

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

Resposta

204 Nenhum conteúdo

A resposta bem-sucedida está em branco com o código de status 204.

400 Solicitação inválida

A solicitação não foi compreendida pelo servidor.

Exemplo

{
    "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 Não autorizado

O usuário não está autorizado.

Exemplo:

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

DELETE

Solicitação: /exchangeRateType/{code}
:
exclui o tipo de taxa cambial.

Exclui o tipo de taxa cambial existente definido pelo usuário. Também excluirá o mapeamento de tipo de taxa cambial externa, se presente.
Os dois tipos de taxa cambial reservados não podem ser excluídos. Esses são os tipos de taxa cambial "Média mensal" e "Fim do mês".

Exemplo de URI de solicitação:

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