Ir para o conteúdo

FoccoSMF - Administradora de Pagamentos (SUPPLIER)

Utilização de Serviços de Envio e Consulta de Dados para a Supplier

Para utilização dos serviços da Supplier é utilizado o padrão REST, utilizando JSON para envio e recebimento das informações.

A URL base para utilização dos serviços é o http://<IP>:<PORTA>/<SERVIÇO> do FoccoSMF.

Exemplo: http://localhost:8878/AdministradorPagamentos/SendInvoice

1 - Estrutura Base

1.1 - Request

1.1.1 - Campos

O corpo das demais requisições será enviado pelo atributo Requests.

Atributo Tipo Informação Valor Padrão
ChaveAmbiente string Chave do Ambiente
Modelo string Modelo do Documento "ADMINISTRADOR_PAGAMENTOS"
Cnpj string CNPJ da Empresa
CodigoGenerico string Código Genérico da Plataforma "SUPPLIER"
UrlBase string URL da API
Authentication dynamic Dados da Autenticação
Requests object[] Dados de Envio

1.2 - Response

1.2.1 - Campos

O corpo dos demais retornos será enviado pelo atributo Responses.

Atributo Tipo Informação
Responses dynamic Dados de Retorno

2 - Envio de Solicitação de Concessão de Crédito

2.1 - Request

2.1.1 - URL

<URL base para utilização dos serviços>/AdministradorPagamentos/SendCustomerConcession

2.1.2 - Campos

Atributo Tipo Informação Obrigatório
cnpjCpf string CNPJ/CPF do Cliente Sim
limiteCompraParceiro double Limite de compra no ERP Sim
limiteCompraSugerido double Limite de compra sugerido/solicitado para a Supplier Sim
solicitacaoEmergencial string Indica se é uma solicitação emergencial Sim
informacoesComplementares string Informações complementares do Cliente Não
dadosCadastrais object Dados cadastrais do Cliente Sim
dadosCadastraisPF object Dados cadastrais do Cliente pessoa física Sim
historicoCompras object Histórico de compras do Cliente dos últimos 12 meses (títulos CR vinculados a notas) Sim

2.1.3 - Estrutura Histórico Compras

Atributo Tipo Informação Obrigatório
nf string Número da nota fiscal Sim
dtem string Data de emissão de nota fiscal Sim
dtvc string Data de vencimento da parcela Sim
vlnf decimal Valor da nota fiscal Sim
npc int Número da parcela Não
vlpc double Valor da parcela Sim
pcq string Indicador de quitação do título Sim

2.1.4 - Exemplo

{
    "concessoesCredito": [
        {
            "cnpjCpf": "67612459000117",
            "limiteCompraParceiro": 10000,
            "limiteCompraSugerido": 15000,
            "solicitacaoEmergencial": "N",
            "informacoesComplementares": "Cliente de Testes do Copelli.",
            "dadosCadastrais": {
                "razaoSocial": "PABLO SENITENS",
                "logradouro": "RUA TREZE DE MAIO - DE 10301031 AO FIM, 1111",
                "numero": "1111",
                "complemento": "AO FIM",
                "bairro": "IMIGRANTE",
                "cidade": "CAXIAS DO SUL",
                "uf": "RS",
                "cep": "95702002",
                "nomeContatoFinanceiro": "JOAO SILVA",
                "dddContatoFinanceiro": "54",
                "telContatoFinanceiro": "999999999",
                "emailContatoFinanceiro": "joao@teste.com",
                "nomeContatoCompras": "JOAO SILVA",
                "clienteDesde": "2015-03-02"
            },
            "dadosCadastraisPF": {
                "nome": "PABLO SENITENS",
                "dataNascimento": "2000-11-18",
                "logradouro": "RUA TREZE DE MAIO - DE 10301031 AO FIM, 1111",
                "numero": "1111",
                "complemento": "AO FIM",
                "bairro": "IMIGRANTE",
                "cidade": "CAXIAS DO SUL",
                "uf": "RS",
                "cep": "95702002",
                "nomeContatoFinanceiro": "PABLO SENITENS",
                "dddContatoFinanceiro": "54",
                "telContatoFinanceiro": "999999999",
                "emailContatoFinanceiro": "joao@teste.com"
            },
            "historicoCompras": [
                {
                    "nf": "123-1",
                    "dtem": "2022-03-01",
                    "dtvc": "2022-07-01",
                    "vlnf": 3000,
                    "npc": 3,
                    "vlpc": 1000,
                    "pcq": "S"
                },
                {
                    "nf": "124-1",
                    "dtem": "2022-04-01",
                    "dtvc": "2022-08-01",
                    "vlnf": 3000,
                    "npc": 3,
                    "vlpc": 1000,
                    "pcq": "N"
                }
            ]
        }
    ]
}

2.2 - Response

2.2.1 - Campos

Atributo Tipo Informação
uuidSolicitacao string Identificador universal único
totalOcorrenciasSolicitacao int Total de ocorrências de solicitações
ocorrenciasEmProcessamento int Total de ocorrências em processamento
ocorrenciasRejeitadas int Total de ocorrências rejeitadas
statusSolicitacoes object Array de Status das solicitações enviadas.
codigoRetorno string Código de retorno do processamento
mensagemRetorno string Mensagem de retorno do processamento
dataHoraRetorno string Data e hora do retorno

2.2.2 - Estrutura Status Solicitações

Atributo Tipo Informação
cnpjCpf string CNPJ/CPF do Cliente
codigoAnalise string Código identificador da análise na Supplier
dataSolicitacaoAnalise string Data da solicitação da análise
statusAnalise string Status da análise
statusAnaliseDesc string Descrição do status da análise
pendenciaDocumentacao bool Documentação Pendente
possuiAnaliseEmAndamento bool Possui análise em andamento

2.2.3 - Exemplo

{
    "uuidSolicitacao": "450cb742-5629-4563-95e0-cf370a857c5e",
    "totalOcorrenciasSolicitacao": 1,
    "ocorrenciasEmProcessamento": 1,
    "ocorrenciasRejeitadas": 0,
    "statusSolicitacoes": [
        {
            "cnpjCpf": "67612459000117",
            "codigoAnalise": "1227839",
            "dataSolicitacaoAnalise": "2022-08-03T08:11:50",
            "statusAnalise": "0",
            "statusAnaliseDesc": "Em processamento",
            "pendenciaDocumentacao": false,
            "possuiAnaliseEmAndamento": false
        }
    ],
    "codigoRetorno": "000",
    "mensagemRetorno": "Solicitacao Efetuada com sucesso",
    "dataHoraRetorno": "2022-08-03T08:11:50"
}

3 - Envio de Solicitação de Alteração de Limite de Crédito

3.1 - Request

3.1.1 - URL

<URL base para utilização dos serviços>/AdministradorPagamentos/ChangeCustomerConcession

3.1.2 - Campos

Atributo Tipo Informação Obrigatório
cnpjCpf string CNPJ/CPF do Cliente Sim
limiteCompraParceiro double Limite de compra no ERP Sim
limiteCompraSugerido double Limite de compra sugerido/solicitado para a Supplier Sim
solicitacaoEmergencial string Indica se é uma solicitação emergencial Sim
informacoesComplementares string Informações complementares do Cliente Não
historicoCompras object Histórico de compras do Cliente dos últimos 12 meses (títulos CR vinculados a notas) Sim

3.1.3 - Estrutura Histórico Compras

Atributo Tipo Informação Obrigatório
nf string Número da nota fiscal Sim
dtem string Data de emissão de nota fiscal Sim
dtvc string Data de vencimento da parcela Sim
vlnf decimal Valor da nota fiscal Sim
npc int Número da parcela Não
vlpc double Valor da parcela Sim
pcq string Indicador de quitação do título Sim

3.1.4 - Exemplo

{
    "alteracoesLimite": [
        {
            "cnpjCpf": "67612459000117",
            "limiteCompraParceiro": 10000,
            "limiteCompraSugerido": 350000,
            "solicitacaoEmergencial": "N",
            "informacoesComplementares": "Cliente de Testes do Copelli.",
            "historicoCompras": [
                {
                    "nf": "123-1",
                    "dtem": "2022-03-01",
                    "dtvc": "2022-07-01",
                    "vlnf": 3000,
                    "npc": 3,
                    "vlpc": 1000,
                    "pcq": "S"
                },
                {
                    "nf": "124-1",
                    "dtem": "2022-04-01",
                    "dtvc": "2022-08-01",
                    "vlnf": 3000,
                    "npc": 3,
                    "vlpc": 1000,
                    "pcq": "N"
                }
            ]
        }
    ]
}

3.2 - Response

3.2.1 - Campos

Atributo Tipo Informação
uuidSolicitacao string Identificador universal único
totalOcorrenciasSolicitacao int Total de ocorrências de solicitações
ocorrenciasEmProcessamento int Total de ocorrências em processamento
ocorrenciasRejeitadas int Total de ocorrências rejeitadas
statusSolicitacoes object Array de Status das solicitações enviadas.
codigoRetorno string Código de retorno do processamento
mensagemRetorno string Mensagem de retorno do processamento
dataHoraRetorno string Data e hora do retorno

3.2.2 - Estrutura Status Solicitações

Atributo Tipo Informação
cnpjCpf string