Início > Condição de pagamento
Versão: 2.0
Condição de pagamento
Última Atualização: 20/03/2024
Na plataforma do smartplace existem condições de pagamento de pedidos, por exemplo, caso esteja disponibilizada, pode ser utilizada a condição "7 dias" para o pagamento de um boleto com o prazo de 7 dias.
Este serviço trás a possibilidade de adicionar e deletar condições de pagamento para os clientes.
Estas condições de pagamento estarão disponíveis para os clientes na plataforma da Yandeh.
Este endpoint lista as condições de pagamento do fornecedor, retornando de forma paginada.
Endpoint GET
Parâmetros da requisição
pagina: Integer.
Ex: 1.
por_pagina: Integer.
Ex: 10.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
success
Identificador de sucesso.
Tipo: Boolean.
data
Dados retornados.
Tipo: Array de Objeto.
id
Id da condição de pagamento.
Tipo: Integer.
criado_em
Data de criação da condição de pagamento.
Tipo: Date.
modificado_em
Última data que a condição de pagamento recebeu atualização.
Tipo: Date.
cliente
Id do cliente.
Tipo: String.
cnpj_cliente
CNPJ do cliente.
Tipo: String.
meio_pagamento
Id do meio de pagamento.
Tipo: Boolean.
taxa
Juros/desconto em cima da condição de pagamento.
Tipo: Integer.
codigo_condicao_pagamento
Código interno do fornecedor para a condição de pagamento.
Tipo: Integer ou null.
padrao
Seleção padrão do meio de pagamento.
Tipo: Boolean.
total
Total de condições de pagamento encontradas
Tipo: Integer.
paginacao
Detalhes da situação atual da paginação.
Tipo: Objeto.
total_paginas
Número total de páginas.
Tipo: Integer.
pagina
Página atual.
Tipo: Integer.
por_pagina
Número de itens sendo em exibidos por página.
Tipo: Integer.
tem_proximo
Tipo: Boolean.
Indica se tem mais páginas à frente.
Caso a página solicitada não contenha dados, por exceder o número de páginas válidas, será retornado o status 204 No Content e sem resposta de retorno.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
404 Not Found
O erro é apresentado caso não exista condições de pagamentos cadastradas.
500 Internal Server Error
Se houver uma falha interna será exibida a seguinte mensagem:
GET Condição de pagamento
Última Atualização: 27/11/2024
Sintaxe da Requisição
Para que a requisição do método Post seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da requisição
cnpj
CNPJ do cliente.
Tipo: String.
codigo_condicao_pagamento
código de condição de pagamento do fornecedor, que se refere a um meio de pagamento. Exemplo de meio de pagamento: Boleto Alpe 7 dias.
Tipo: String.
acrescimo_desconto
"A" para indicar um acréscimo e "D" para indicar um desconto.
Tipo: String.
porcentagem
Porcentagem do desconto ou acrescimo.
Tipo: String.
meio_pagamento_padrao
Meio de pagamento padrão.
Tipo: String.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 207, essa será a resposta que você receberá:
Elementos da Resposta
É retornado um JSON com os seguintes campos.
SUCESSO
Retorna a condição de pagamento caso ela seja aplicada com sucesso.
Tipo: Array de JSON.
ERRO
Retorna as condições de pagamento que tiveram algum erro.
Tipo: Array de JSON.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
207 Mult-Status (com erro)
422 Validation Error
POST condição de pagamento
Última Atualização: 14/03/2024
O post condição de pagamento trás a possibilidade de adicionar e atualizar condições de pagamento do fornecedor.
Endpoint POST
DELETE condição de pagamento
Última Atualização: 15/03/2024
O post condição de pagamento trás a possibilidade de remover condições de pagamento de clientes.
Endpoint DELETE
Sintaxe da Requisição
Para que a requisição do método Delete seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da requisição
cnpj_cliente
CNPJ do cliente.
Tipo: String.
codigo_condicao_pagamento
código de condição de pagamento.
Tipo: String.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
406 Not Acceptable
422 Validation Error