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	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
motivoRetornoAnalise	string	Motivo do retorno da Análise
pendenciaDocumentacao	bool	Documentação Pendente
possuiAnaliseEmAndamento	bool	Possui análise em andamento

3.2.3 - Exemplo

{
    "uuidSolicitacao": "334887ef-ad4f-4fc6-8a83-08052d2826c4",
    "totalOcorrenciasSolicitacao": 1,
    "ocorrenciasEmProcessamento": 1,
    "ocorrenciasRejeitadas": 0,
    "statusSolicitacoes": [
        {
            "cnpjCpf": "67612459000117",
            "codigoAnalise": "1227891",
            "dataSolicitacaoAnalise": "2022-08-03T16:47:56",
            "statusAnalise": "0",
            "statusAnaliseDesc": "Em processamento",
            "motivoRetornoAnalise": "Sua solicitação foi encaminhada para a área de crédito e será respondida em até 5 dias úteis.",
            "pendenciaDocumentacao": false,
            "possuiAnaliseEmAndamento": false
        }
    ],
    "codigoRetorno": "000",
    "mensagemRetorno": "Solicitação recebida e encaminhada para processamento",
    "dataHoraRetorno": "2022-08-03T16:47:56"
}

4 - Consulta de Concessão de Análise de Crédito

4.1 - Request

4.1.1 - URL

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

4.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
cnpjCpf	string	CNPJ/CPF do Cliente	Sim
codigoAnalise	string	Código identificador da análise na Supplier	Sim

4.1.3 - Exemplo

{
    "cnpjCpf": "67612459000117",
    "codigoAnalise": "1227891"
}

4.2 - Response

4.2.1 - Campos

Atributo	Tipo	Informação
analise	object	Objeto com os dados da análise.
codigoRetorno	string	Código de retorno do processamento
mensagemRetorno	string	Mensagem de retorno do processamento
dataHoraRetorno	string	Data e hora do retorno

4.2.2 - Estrutura Análise

Atributo	Tipo	Informação
codigoGrupo	string	Código do grupo vinculado à Supplier
nome	string	Nome do Cliente
cnpjCpf	string	CNPJ/CPF do Cliente
codigoAnalise	string	Código identificador da análise na Supplier
dataSolicitacaoAnalise	DateTimeOffset	Data da solicitação da análise
dataConclusaoAnalise	DateTimeOffset	Data de conclusão da análise
statusAnalise	string	Status da análise
statusAnaliseDesc	string	Descrição do status da análise
motivoRetornoAnalise	string	Motivo do retorno da análise
uuidSolicitacao	string	Identificador universal único
limiteCompraAprovado	double	Limite de compra aprovado para o cliente

4.2.3 - Exemplo

{
    "analise": {
        "tipoAnalise": "CONCESSAO_LIMITE",
        "codigoGrupo": "O213",
        "descricaoGrupo": "IRMÃOS FISCHER",
        "nome": "PABLO SENITENS",
        "cnpjCpf": "67612459000117",
        "raizCnpj": "67612459",
        "codigoAnalise": "1226415",
        "dataSolicitacaoAnalise": "2022-07-18T10:38:01",
        "dataConclusaoAnalise": "2022-07-18T10:42:36",
        "statusAnalise": "1",
        "statusAnaliseDesc": "Aprovada",
        "motivoRetornoAnalise": "CARTÃO APROVADO",
        "uuidSolicitacao": "7f969849-ba2e-4444-a311-c693cf2e5e8d",
        "pendenciaDocumentacao": false,
        "possuiAnaliseEmAndamento": false,
        "possuiCartaoSupplier": true,
        "limiteCompraAprovado": 300000,
        "limiteCoobrigacaoAprovado": 0,
        "tipoSolicitacao": "NORMAL",
        "limiteSugerido": 0
    },
    "codigoRetorno": "000",
    "mensagemRetorno": "Solicitação processada com sucesso",
    "dataHoraRetorno": "2022-08-08T07:50:41"
}

5 - Consulta de Status de Cliente

5.1 - Request

5.1.1 - URL

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

5.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
cnpjCpf	string	CNPJ/CPF do Cliente	Sim

5.1.3 - Exemplo

{
    "cnpjCpf": "67612459000117"
}

5.2 - Response

5.2.1 - Campos

Atributo	Tipo	Informação
Cliente	object	Objeto com os dados do Cliente.
codigoRetorno	string	Código de retorno do processamento
mensagemRetorno	string	Mensagem de retorno do processamento
dataHoraRetorno	string	Data e hora do retorno

5.2.2 - Estrutura Cliente

Atributo	Tipo	Informação
codigoGrupo	string	Código do grupo vinculado à Supplier
cnpjCpf	string	CNPJ/CPF do Cliente
cnpjCliente	string	CNPJ do Cliente
raizCnpj	string	Raiz do CNPJ
razaoSocial	string	Razão Social do Cliente
statusCliente	string	Status do Cliente
statusClienteDesc	string	Descrição do Status do cliente
numeroDiasAtraso	int	Número de dias de atraso
tipoCliente	string	Tipo de Cliente
tipoPessoa	string	Tipo de Pessoa
permiteFaturarAPrazoNoParceiro	string	Indica se permite faturar a prazo no parceiro
limiteCompra	object	Objeto com os dados de limite de compra

5.2.3 - Estrutura Limite Compra

Atributo	Tipo	Informação
limiteCompraTotal	double	Limite de Compra Total
limiteCompraDisponivel	double	Limite de Compra Disponível
limiteCompraLiberado	double	Limite de Compra Liberado
limiteCompraPreAutorizado	double	Limite de Compra Pré-autorizado
limiteCompraUtilizado	double	Limite de Compra Utilizado

5.2.4 - Exemplo

{
    "cliente": {
        "codigoGrupo": "O213",
        "cnpjCpf": "00000000000000",
        "cnpjCliente": "00000000000000",
        "raizCnpj": "67612459",
        "razaoSocial": "PABLO SENITENS",
        "statusCliente": "0",
        "statusClienteDesc": "Ativo",
        "numeroDiasAtraso": 0,
        "tipoCliente": "B",
        "tipoPessoa": "1",
        "permiteFaturarAPrazoNoParceiro": "S",
        "limiteCompra": {
            "limiteCompraTotal": 300000.0,
            "limiteCompraDisponivel": 300000.0,
            "limiteCompraLiberado": 300000.0,
            "limiteCompraPreAutorizado": 0.0,
            "limiteCompraUtilizado": 0.0
        }
    },
    "codigoRetorno": "000",
    "mensagemRetorno": "Solicitação processada com sucesso",
    "dataHoraRetorno": "2022-09-12T11:55:43-03:00"
}

6 - Consulta de Status de Cliente em Lote

6.1 - Request

6.1.1 - URL

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

6.1.2 - Campos

Não se aplica

6.2 - Response

6.2.1 - Campos

Atributo	Tipo	Informação
Cliente	object	Array de objeto com os dados do Cliente.
codigoRetorno	string	Código de retorno do processamento
mensagemRetorno	string	Mensagem de retorno do processamento
dataHoraRetorno	string	Data e hora do retorno

6.2.2 - Estrutura Cliente

Atributo	Tipo	Informação
codigoGrupo	string	Código do grupo vinculado à Supplier
cnpjCpf	string	CNPJ/CPF do Cliente
cnpjCliente	string	CNPJ do Cliente
raizCnpj	string	Raiz do CNPJ
razaoSocial	string	Razão Social do Cliente
statusCliente	string	Status do Cliente
statusClienteDesc	string	Descrição do Status do cliente
numeroDiasAtraso	int	Número de dias de atraso
tipoCliente	string	Tipo de Cliente
tipoPessoa	string	Tipo de Pessoa
permiteFaturarAPrazoNoParceiro	string	Indica se permite faturar a prazo no parceiro
limiteCompra	object	Objeto com os dados de limite de compra

6.2.3 - Estrutura Limite Compra

Atributo	Tipo	Informação
limiteCompraTotal	double	Limite de Compra Total
limiteCompraDisponivel	double	Limite de Compra Disponível
limiteCompraLiberado	double	Limite de Compra Liberado
limiteCompraPreAutorizado	double	Limite de Compra Pré-autorizado
limiteCompraUtilizado	double	Limite de Compra Utilizado

6.2.4 - Exemplo

{
    "cliente": [
        {
            "codigoGrupo": "O213",
            "cnpjCpf": "00000000000000",
            "cnpjCliente": "00000000000000",
            "raizCnpj": "67612459",
            "razaoSocial": "PABLO SENITENS",
            "statusCliente": "0",
            "statusClienteDesc": "Ativo",
            "numeroDiasAtraso": 0,
            "tipoCliente": "B",
            "tipoPessoa": "1",
            "permiteFaturarAPrazoNoParceiro": "S",
            "limiteCompra": {
                "limiteCompraTotal": 300000.0,
                "limiteCompraDisponivel": 300000.0,
                "limiteCompraLiberado": 300000.0,
                "limiteCompraPreAutorizado": 0.0,
                "limiteCompraUtilizado": 0.0
            }
        }
    ],
    "codigoRetorno": "000",
    "mensagemRetorno": "Solicitação processada com sucesso",
    "dataHoraRetorno": "2022-09-12T11:55:43-03:00"
}

7 - Não implementado - Consulta de Pré-Autorização Vigente

7.1 - Request

7.1.1 - URL

Não se aplica

7.1.2 - Campos

Não se aplica

7.2 - Response

7.2.1 - Campos

Atributo	Tipo	Informação	Obrigatório
preAutorizacoes	object	Retorno da consulta da Pré-Autorização	Sim

7.2.2 - Estrutura preAutorizacoes

Atributo	Tipo	Informação	Obrigatório
cnpjCpf	string	CNPJ/CPF do Cliente	Sim
numeroPedidoComSequencial	string	Número do pedido com sequencial	Sim
codigoPreAutorizacao	string	Código da Pré-Autorização	Sim
numeroPedido	string	Número do pedido	Sim
statusPreAutorizacao	string	Código do Status da Pré-Autorização	Sim
statusPreAutorizacaoDesc	string	Descrição do Status da Pré-Autorização	Sim
valorPreAutorizado	string	Valor Pré-autorizado	Sim
dataSolicitacaoPreAutorizacao	string	Data de solicitação da Pré-Autorização	Sim
dataVigenciaPreAutorizacao	string	Data de vigência da Pré-Autorização	Sim
dataAtualizacaoPreAutorizacao	string	Data de atualização da Pré-Autorização	Sim
taxas	object	Especificação das taxas	Sim

7.2.3 - Estrutura taxas

Atributo	Tipo	Informação	Obrigatório
idTipoTaxa	string	Identificador do tipo de taxa	Sim
tipoTaxa	string	Tipo de taxa	Sim
valorTaxa	double	Valor da taxa	Sim

7.2.4 - Exemplo

{
    "preAutorizacoes": [
        {
            "cnpjCpf": "00000000000000",
            "numeroPedidoComSequencial": "48",
            "codigoPreAutorizacao": 44086086,
            "numeroPedido": "27082022",
            "statusPreAutorizacao": "1",
            "statusPreAutorizacaoDesc": "Vigente",
            "valorPreAutorizado": 200000.0,
            "dataSolicitacaoPreAutorizacao": "2022-09-22",
            "dataVigenciaPreAutorizacao": "2022-09-26",
            "dataAtualizacaoPreAutorizacao": "2022-09-22",
            "taxas": [
                {
                    "idTipoTaxa": "1",
                    "tipoTaxa": "ANTECIPACAO",
                    "valorTaxa": 2.43
                }
            ]
        }
}

8 - Envio/Criação de Pré-Autorização

8.1 - Request

8.1.1 - URL

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

8.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
cnpjCpf	string	CNPJ/CPF do Cliente	Sim
cnpjParceiro	string	CNPJ da empresa/parceiro	Sim
numeroPedido	string	Número do pedido	Sim
valorPreAutorizacao	double	Valor total do pedido (já com o percentual adicional) que será reservado	Sim
numeroParcelas	int	Quantidade de parcelas do pedido (conforme condição de pagamento)	Sim
parcelas	object	Númeração de cada parcela e data de vencimento, conforme a condição de pagamento do pedido de venda	Sim
Sim

8.1.3 - Estrutura parcelas

Atributo	Tipo	Informação	Obrigatório
numeroParcela	int	Numeração da parcela	Sim
dataVencimento	string	Data de vencimento da parcela	Sim

8.1.4 - Exemplo

{
    "cnpjCpf": "00000000000000",
    "cnpjParceiro": "00000000000000",
    "numeroPedido": "27082022",
    "valorPreAutorizacao": 1589.19,
    "numeroParcelas": 3,
    "parcelas": [
        {
            "numeroParcela": 1,
            "dataVencimento": "2022-09-26"
        },
        {
            "numeroParcela": 2,
            "dataVencimento": "2022-10-26"
        },
        {
            "numeroParcela": 3,
            "dataVencimento": "2022-11-25"
        }
    ]
}

8.2 - Response

8.2.1 - Campos

Atributo	Tipo	Informação	Obrigatório
preAutorizacao	object	Retorno do envio da Pré-Autorização	Sim

8.2.2 - Estrutura preAutorizacao

Atributo	Tipo	Informação	Obrigatório
cnpjCpf	string	CNPJ/CPF do Cliente	Sim
codigoPreAutorizacao	string	Código da Pré-Autorização	Sim
numeroPedido	string	Número do pedido	Sim
statusPreAutorizacao	string	Código do Status da Pré-Autorização	Sim
statusPreAutorizacaoDesc	string	Descrição do Status da Pré-Autorização	Sim
valorPreAutorizado	string	Valor Pré-autorizado	Sim
dataSolicitacaoPreAutorizacao	string	Data de solicitação da Pré-Autorização	Sim
dataVigenciaPreAutorizacao	string	Data de vigência da Pré-Autorização	Sim
dataAtualizacaoPreAutorizacao	string	Data de atualização da Pré-Autorização	Sim
taxas	object	Especificação das taxas	Sim

8.2.3 - Estrutura taxas

Atributo	Tipo	Informação	Obrigatório
idTipoTaxa	string	Identificador do tipo de taxa	Sim
tipoTaxa	string	Tipo de taxa	Sim
valorTaxa	double	Valor da taxa	Sim

8.2.4 - Exemplo

{
    "preAutorizacao": {
        "cnpjCpf": "00000000000000",
        "codigoPreAutorizacao": 44086086,
        "numeroPedido": "27082022",
        "statusPreAutorizacao": "1",
        "statusPreAutorizacaoDesc": "Vigente",
        "valorPreAutorizado": 200000.0,
        "dataSolicitacaoPreAutorizacao": "2022-09-22",
        "dataVigenciaPreAutorizacao": "2022-09-26",
        "dataAtualizacaoPreAutorizacao": "2022-09-22",
        "taxas": [
            {
                "idTipoTaxa": "1",
                "tipoTaxa": "ANTECIPACAO",
                "valorTaxa": 2.43
            }
        ]
    }
}

9 - Alteração da Pré-Autorização

9.1 - Request

9.1.1 - URL

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

9.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
cnpjCpf	string	CNPJ/CPF do Cliente	Sim
cnpjParceiro	string	CNPJ da empresa/parceiro	Sim
numeroPedido	string	Número do pedido	Sim
codigoPreAutorizacao	int	Passar o número da pré autorização que deseja-se alterar	Sim
valorPreAutorizacao	double	Valor total do pedido (já com o percentual adicional) que será reservado	Sim
numeroParcelas	int	Quantidade de parcelas do pedido (conforme condição de pagamento)	Sim
parcelas	object	Númeração de cada parcela e data de vencimento, conforme a condição de pagamento do pedido de venda	Sim
Sim

9.1.3 - Estrutura parcelas

Atributo	Tipo	Informação	Obrigatório
numeroParcela	int	Numeração da parcela	Sim
dataVencimento	string	Data de vencimento da parcela	Sim

9.1.4 - Exemplo

{
    {
        "cnpjCpf": "00000000000000",
        "cnpjParceiro": "00000000000000",
        "numeroPedido": "27082022",
        "codigoPreAutorizacao": 44086086,
        "valorPreAutorizacao": 1589.19,
        "numeroParcelas": 3,
        "parcelas": [
                {
                    "numeroParcela": 1,
                    "dataVencimento": "2022-09-26"
                },
                {
                    "numeroParcela": 2,
                    "dataVencimento": "2022-10-26"
                },
                {
                    "numeroParcela": 3,
                    "dataVencimento": "2022-11-25"
                }
        ]
    }
}

9.2 - Response

9.2.1 - Campos

Atributo	Tipo	Informação	Obrigatório
cnpjCpf	string	CNPJ/CPF do Cliente	Sim
codigoPreAutorizacao	string	Código da Pré-Autorização	Sim
numeroPedido	string	Número do pedido	Sim
statusPreAutorizacao	string	Código do Status da Pré-Autorização	Sim
statusPreAutorizacaoDesc	string	Descrição do Status da Pré-Autorização	Sim
valorPreAutorizado	string	Valor Pré-autorizado	Sim
dataSolicitacaoPreAutorizacao	string	Data de solicitação da Pré-Autorização	Sim
dataVigenciaPreAutorizacao	string	Data de vigência da Pré-Autorização	Sim
dataAtualizacaoPreAutorizacao	string	Data de atualização da Pré-Autorização	Sim
taxas	object	Especificação das taxas	Sim

9.2.2 - Estrutura taxas

Atributo	Tipo	Informação	Obrigatório
idTipoTaxa	string	Identificador do tipo de taxa	Sim
tipoTaxa	string	Tipo de taxa	Sim
valorTaxa	double	Valor da taxa	Sim

9.2.3 - Exemplo

{
    "preAutorizacao": {
        "cnpjCpf": "00000000000000",
        "codigoPreAutorizacao": 44086086,
        "numeroPedido": "27082022",
        "statusPreAutorizacao": "1",
        "statusPreAutorizacaoDesc": "Vigente",
        "valorPreAutorizado": 200000.0,
        "dataSolicitacaoPreAutorizacao": "2022-09-22",
        "dataVigenciaPreAutorizacao": "2022-09-26",
        "dataAtualizacaoPreAutorizacao": "2022-09-22",
        "taxas": [
            {
                "idTipoTaxa": "1",
                "tipoTaxa": "ANTECIPACAO",
                "valorTaxa": 2.43
            }
        ]
    }
}

10 - Cancelamento da Pré-Autorização

10.1 - Request

10.1.1 - URL

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

10.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
cnpjCpf	string	CNPJ/CPF do Cliente	Sim
codigoPreAutorizacao	int	Passar o número da pré autorização que deseja-se cancelar	Sim

10.1.3 - Exemplo

{
    "cnpjCpf": "00000000000000",
    "codigoPreAutorizacao": 44086086
}

10.2 - Response

10.2.1 - Campos

Atributo	Tipo	Informação	Obrigatório
cnpjCpf	string	CNPJ/CPF do Cliente	Sim
codigoPreAutorizacao	string	Código da Pré-Autorização	Sim
numeroPedido	string	Número do pedido	Sim
statusPreAutorizacao	string	Código do Status da Pré-Autorização	Sim
statusPreAutorizacaoDesc	string	Descrição do Status da Pré-Autorização	Sim
valorPreAutorizado	string	Valor Pré-autorizado	Sim
dataSolicitacaoPreAutorizacao	string	Data de solicitação da Pré-Autorização	Sim
dataCancelamentoPreAutorizacao	string	Data de vigência da Pré-Autorização	Sim

10.2.3 - Exemplo

{
    "preAutorizacao": {
        "cnpjCpf": "00000000000000",
        "codigoPreAutorizacao": 44086086,
        "numeroPedido": "27082022",
        "statusPreAutorizacao": "3",
        "statusPreAutorizacaoDesc": "Cancelada",
        "valorPreAutorizado": 0.0,
        "dataSolicitacaoPreAutorizacao": "2022-09-22",
        "dataCancelamentoPreAutorizacao": "2022-09-26"
    }
}

11 - Renovação da Pré-Autorização

11.1 - Request

11.1.1 - URL

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

11.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
cnpjCpf	string	CNPJ/CPF do Cliente	Sim
codigoPreAutorizacao	int	Passar o número da pré autorização que deseja-se cancelar	Sim

11.1.3 - Exemplo

{
    "cnpjCpf": "00000000000000",
    "codigoPreAutorizacao": 44086086
}

11.2 - Response

11.2.1 - Campos

Atributo	Tipo	Informação	Obrigatório
cnpjCpf	string	CNPJ/CPF do Cliente	Sim
codigoPreAutorizacao	string	Código da Pré-Autorização	Sim
numeroPedido	string	Número do pedido	Sim
statusPreAutorizacao	string	Código do Status da Pré-Autorização	Sim
statusPreAutorizacaoDesc	string	Descrição do Status da Pré-Autorização	Sim
valorPreAutorizado	string	Valor Pré-autorizado	Sim
dataSolicitacaoPreAutorizacao	string	Data de solicitação da Pré-Autorização	Sim
dataVigenciaPreAutorizacao	string	Data de vigência da Pré-Autorização	Sim
dataAtualizacaoPreAutorizacao	string	Data de atualização da Pré-Autorização	Sim
taxas	object	Especificação das taxas	Sim

11.2.2 - Estrutura taxas

Atributo	Tipo	Informação	Obrigatório
idTipoTaxa	string	Identificador do tipo de taxa	Sim
tipoTaxa	string	Tipo de taxa	Sim
valorTaxa	double	Valor da taxa	Sim

11.2.3 - Exemplo

{
    "preAutorizacao": {
        "cnpjCpf": "00000000000000",
        "codigoPreAutorizacao": 44086086,
        "numeroPedido": "27082022",
        "statusPreAutorizacao": "1",
        "statusPreAutorizacaoDesc": "Vigente",
        "valorPreAutorizado": 200000.0,
        "dataSolicitacaoPreAutorizacao": "2022-09-22",
        "dataVigenciaPreAutorizacao": "2022-09-26",
        "dataAtualizacaoPreAutorizacao": "2022-09-22",
        "taxas": [
            {
                "idTipoTaxa": "1",
                "tipoTaxa": "ANTECIPACAO",
                "valorTaxa": 2.43
            }
        ]
    }
}

12 - Envio de Nota Fiscal de Saída

12.1 - Request

12.1.1 - URL

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

12.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
cnpjCpf	string	CNPJ/CPF do Cliente	Sim
cnpjParceiro	string	CNPJ do Parceiro	Sim
codigoPreAutorizacao	long	Código de Pre-autorização do pedido da nota na Supplier	Não
numeroParcelas	int	Quantidade de parcelas da nota	Sim
numeroPedido	long	Número do pedido	Sim
numeroNotaFiscal	string	Número da nota fiscal de saída	Sim
valorNotaFiscal	double	Valor da Nota Fiscal	Sim
dataEmissaoNotaFiscal	string	Data de emissão da nota fiscal no formato 'yyyy-MM-dd'	Sim
chaveAcessoNotaFiscal	string	Chave de Acesso da Nota Fiscal Eletrônica	Sim
tipoNotaFiscal	string	Tipo da NotaFiscal	Não
prazoRecebimentoParceiro	long	Prazo de Recebimento do Parceiro	Não
tipoRecebimentoParceiro	string	Tipo de Recebimento do Parceiro	Não
tipoTransacao	string	Tipo de Transação	Não
parcelas	object	Array de objetos de parcelas da nota	Sim

12.1.3 - Estrutura de Parcelas

Atributo	Tipo	Informação	Obrigatório
numeroParcela	int	Número da Parcela	Sim
dataVencimento	string	Data de vencimento da parcela no formato 'yyyy-MM-dd'	Sim
valorParcela	double	Valor da Parcela	Sim

12.1.4 - Exemplo

{
    "cnpjCpf": "00000000000000",
    "cnpjParceiro": "00000000000000",
    "codigoPreAutorizacao": 44086569,
    "numeroParcelas": 3,
    "numeroPedido": "",
    "numeroNotaFiscal": "5102022111",
    "valorNotaFiscal": 1000.0,
    "dataEmissaoNotaFiscal": "2022-11-25",
    "chaveAcessoNotaFiscal": "43210593200111000122550019999896831000572049",
    "parcelas": [
        {
            "numeroParcela": 1,
            "dataVencimento": "2022-12-25",
            "valorParcela": 300
        },
        {
            "numeroParcela": 2,
            "dataVencimento": "2023-01-24",
            "valorParcela": 300
        },
        {
            "numeroParcela": 3,
            "dataVencimento": "2023-02-23",
            "valorParcela": 400
        }
    ]
}

12.2 - Response

12.2.1 - Campos

Atributo	Tipo	Informação
cnpjCpf	string	CNPJ/CPF do Cliente
razaoSocialCliente	string	Razão Social do Cliente
cnpjParceiro	string	CNPJ do Parceiro
codigoTransacao	string	Código da Transação
valorTotalTransacao	double	Valor total da transação
statusTransacao	string	Status da transação
taxas	object	Array de objetos de estrutura de taxas
parcelas	object	Array de objeto de estrutura de parcelas
codigoRetorno	string	Código de retorno do processamento
mensagemRetorno	string	Mensagem de retorno do processamento
dataHoraRetorno	string	Data e hora do retorno

12.2.2 - Estrutura taxas

Atributo	Tipo	Informação
idTipoTaxa	string	Identificador do tipo de taxa
tipoTaxa	string	Tipo de taxa
valorTaxa	double	Valor da taxa
valorTaxaEmReais	double	Valor da taxa em reais

12.2.3 - Estrutura parcelas

Atributo	Tipo	Informação
numeroParcela	int	Número da parcela
dataVencimentoParcela	string	Data de Vencimento da Parcela no formato 'yyyy-MM-dd'
valorTotalParcela	double	Valor total da parcela
valorRecebimentoParceiro	double	Valor de recebimento do parceiro
dataRecebimentoParceiro	string	Data de Recebimento do parceiro no formato 'yyyy-MM-dd'
taxasParcela	object	Objeto de estrutura de taxas

12.2.4 - Exemplo

{
    "transacao": {
        "cnpjCpf": "00000000000000",
        "razaoSocialCliente": "PABLO SENITENS",
        "cnpjParceiro": "00000000000000",
        "codigoAutorizacao": "44086912",
        "razaoSocialEmitente": "IRMAOS FISCHER SA",
        "codigoSolicitacao": 0,
        "codigoTransacao": "52460051020221",
        "numeroPedido": "220920222",
        "numeroNotaFiscal": "51020221",
        "valorNotaFiscal": 1000.0,
        "numeroParcelas": 3,
        "valorPrincipalTransacao": 1000.0,
        "valorTotalTransacao": 1000.0,
        "dataEmissaoNotaFiscal": "2022-10-05",
        "statusTransacao": "0",
        "statusTransacaoDesc": "Em aberto",
        "valorSaldoAberto": 1000.0,
        "dataCancelamentoTotal": null,
        "tipoTransacaoSolicitada": "0",
        "tipoTransacaoSolicitadaDesc": "Compra com Cartao",
        "tipoTransacaoImplantada": "0",
        "tipoTransacaoImplantadaDesc": "Compra com Cartao",
        "tipoRecebimentoParceiro": "3",
        "tipoRecebimentoParceiroDesc": "Antecipado - Pagamento em DN",
        "dataHoraImplantacao": "2022-10-05T10:52:49",
        "codigoContrato": "012492930",
        "tipoCliente": "B",
        "valorRecebimentoParceiro": 950.6,
        "dataRecebimentoParceiro": "2022-10-06",
        "dataPrevisaoCoobrigacao": null,
        "taxas": [
            {
                "idTipoTaxa": "1",
                "tipoTaxa": "ANTECIPACAO",
                "valorTaxa": 2.43,
                "valorTaxaEmReais": 49.4
            }
        ],
        "parcelas": [
            {
                "numeroParcela": 1,
                "dataVencimentoParcela": "2022-11-04",
                "dataVencimento": "2022-11-04",
                "valorParcela": 333.33,
                "valorTotalParcela": 333.33,
                "saldoAbertoParcela": 333.33,
                "statusParcela": "0",
                "statusParcelaDesc": "Em aberto",
                "valorRecebimentoParceiro": 325.23,
                "dataRecebimentoParceiro": "2022-10-06",
                "taxasParcela": [
                    {
                        "idTipoTaxa": "1",
                        "tipoTaxa": "ANTECIPACAO",
                        "valorTaxa": 2.43,
                        "valorTaxaEmReais": 8.1
                    }
                ],
                "linhaDigitavel": null,
                "codigoDeBarras": null
            },
            {
                "numeroParcela": 2,
                "dataVencimentoParcela": "2022-12-04",
                "dataVencimento": "2022-12-04",
                "valorParcela": 333.33,
                "valorTotalParcela": 333.33,
                "saldoAbertoParcela": 333.33,
                "statusParcela": "0",
                "statusParcelaDesc": "Em aberto",
                "valorRecebimentoParceiro": 316.93,
                "dataRecebimentoParceiro": "2022-10-06",
                "taxasParcela": [
                    {
                        "idTipoTaxa": "1",
                        "tipoTaxa": "ANTECIPACAO",
                        "valorTaxa": 2.43,
                        "valorTaxaEmReais": 16.4
                    }
                ],
                "linhaDigitavel": null,
                "codigoDeBarras": null
            },
            {
                "numeroParcela": 3,
                "dataVencimentoParcela": "2023-01-03",
                "dataVencimento": "2023-01-03",
                "valorParcela": 333.34,
                "valorTotalParcela": 333.34,
                "saldoAbertoParcela": 333.34,
                "statusParcela": "0",
                "statusParcelaDesc": "Em aberto",
                "valorRecebimentoParceiro": 308.44,
                "dataRecebimentoParceiro": "2022-10-06",
                "taxasParcela": [
                    {
                        "idTipoTaxa": "1",
                        "tipoTaxa": "ANTECIPACAO",
                        "valorTaxa": 2.43,
                        "valorTaxaEmReais": 24.9
                    }
                ],
                "linhaDigitavel": null,
                "codigoDeBarras": null
            }
        ]
    },
    "statusPreAutorizacoes": [
        {
            "cnpjCpf": "00000000000000",
            "numeroPedidoComSequencial": "54",
            "codigoPreAutorizacao": 44086569,
            "numeroPedido": "220920222",
            "statusPreAutorizacao": "1",
            "statusPreAutorizacaoDesc": "Vigente",
            "valorPreAutorizado": 589.19,
            "dataSolicitacaoPreAutorizacao": "2022-09-29",
            "dataVigenciaPreAutorizacao": "2022-10-06",
            "dataAtualizacaoPreAutorizacao": "2022-10-05",
            "taxas": [
                {
                    "idTipoTaxa": "1",
                    "tipoTaxa": "ANTECIPACAO",
                    "valorTaxa": 2.43
                }
            ]
        }
    ],
    "codigoRetorno": "000",
    "mensagemRetorno": "Solicitação processada com sucesso.",
    "dataHoraRetorno": "2022-11-25T07:36:18"
}

13 - Consulta de Pós-vendas Devolução/Cancelamento

13.1 - Request

13.1.1 - URL

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

13.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
codigoSolicitacao	string	Número da pós-venda que deseja-se consultar	Sim

13.1.3 - Exemplo

{
    "codigoSolicitacao": "1251824"
}

13.2 - Response

13.2.1 - Campos

Atributo	Tipo	Informação
tipoRequisicao	string	Tipo da requisição
tipoEvento	string	Tipo do evento
devolucao	object	Objeto de estrutura de devolução
codigoRetorno	string	Código de retorno do processamento
mensagemRetorno	string	Mensagem de retorno do processamento
dataHoraRetorno	string	Data e hora do retorno

13.2.2 - Estrutura devolução

Atributo	Tipo	Informação
cnpjCliente	string	CNPJ/CPF do cliente
codigoTransacao	string	Código da transação
codigoSolicitacao	string	Código da solicitação
dataHoraSolicitacao	date	Data da solicitação
statusSolicitacao	string	Status da solicitação
statusSolicitacaoDesc	double	Descrição do status da solicitação
numeroNotaFiscal	string	Nùmero da nota fiscal
dataDebitoParceiro	string	Data de débito do parceiro
valorDebitoParceiro	double	Valor de débito do parceiro
valorDebitoPrincipalNF	double	Valor de débito principal
valorDebitoTaxaNF	double	Valor de débito de taxa
valorDebitoTotalNF	double	Valor de débito total
valorDevolucaoSolicitado	double	Valor de devolução solicitado
taxaEfetivacaoDebitoNF	double	Taxa efetiva do débito
dataConclusao	string	Data da conclusão no formato 'yyyy-MM-dd'
tipoRecebimentoParceiro	string	Tipo de recebimento do parceiro
parcelas	object	Objeto de estrutura de parcelas

13.2.3 - Estrutura parcelas

Atributo	Tipo	Informação
numeroParcela	int	Número da parcela
dataVencimentoParcela	string	Data de vencimento da parcela no formato 'yyyy-MM-dd'
valorDebitoPrincipalParcela	double	Valor de débito total da parcela
valorDebitoTaxaParcela	double	Valor de débito de taxa da parcela
valorDebitoTotalParcela	double	Valor de débito total da parcela
valorDevolucaoSolicitadoParcela	double	Valor de devolução solicitado da parcela
taxaEfetivacaoDebitoParcela	double	Taxa de efetivação do débito da parcela
dataDebitoParceiro	string	Data de débito do parceiro no formato 'yyyy-MM-dd'
taxasEstorno	object	Objeto de estrutura de taxas

13.2.4 - Estrutura taxas

Atributo	Tipo	Informação
idTipoTaxa	string	Identificador do tipo de taxa
tipoTaxa	string	Tipo de taxa
valorTaxa	double	Valor da taxa
valorTaxaEmReais	double	Valor da taxa em reais

13.2.5 - Exemplo

{
    "tipoRequisicao": "2",
    "tipoEvento": "1",
    "devolucao": {
        "cnpjCliente": "00000000000000",
        "codigoTransacao": "7475102022111",
        "codigoSolicitacao": "1251824",
        "dataHoraSolicitacao": "2022-12-09T09:48:09",
        "statusSolicitacao": "1",
        "statusSolicitacaoDesc": "APROVADA",
        "numeroNotaFiscal": "5102022111",
        "dataDebitoParceiro": "2022-12-12",
        "valorDebitoParceiro": 707.76,
        "valorDebitoPrincipalNF": 703.44,
        "valorDebitoTaxaNF": 4.32,
        "valorDebitoTotalNF": 707.76,
        "valorDevolucaoSolicitado": 740.00,
        "taxaEfetivacaoDebitoNF": 1.54,
        "dataConclusao": "2022-12-09",
        "tipoRecebimentoParceiro": "3",
        "parcelas": [
            {
                "numeroParcela": 1,
                "dataVencimentoParcela": "2022-12-25",
                "valorDebitoPrincipalParcela": 316.86,
                "valorDebitoTaxaParcela": 1.95,
                "valorDebitoTotalParcela": 318.81,
                "valorDevolucaoSolicitadoParcela": 333.33,
                "taxaEfetivacaoDebitoParcela": 1.54,
                "dataDebitoParceiro": "2022-12-12",
                "taxasEstorno": []
            },
            {
                "numeroParcela": 2,
                "dataVencimentoParcela": "2023-01-24",
                "valorDebitoPrincipalParcela": 316.86,
                "valorDebitoTaxaParcela": 1.95,
                "valorDebitoTotalParcela": 318.81,
                "valorDevolucaoSolicitadoParcela": 333.33,
                "taxaEfetivacaoDebitoParcela": 1.54,
                "dataDebitoParceiro": "2022-12-12",
                "taxasEstorno": []
            },
            {
                "numeroParcela": 3,
                "dataVencimentoParcela": "2023-02-23",
                "valorDebitoPrincipalParcela": 69.72,
                "valorDebitoTaxaParcela": 0.42,
                "valorDebitoTotalParcela": 70.14,
                "valorDevolucaoSolicitadoParcela": 73.34,
                "taxaEfetivacaoDebitoParcela": 1.54,
                "dataDebitoParceiro": "2022-12-12",
                "taxasEstorno": []
            }
        ]
    },
    "codigoRetorno": "000",
    "mensagemRetorno": "Solicitação processada com sucesso.",
    "dataHoraRetorno": "2023-02-13T10:56:11"
}

14 - Envio de Pós-Venda (Devolução/Cancelamento)

14.1 - Request

14.1.1 - URL

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

14.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
cnpjCliente	string	CNPJ do cliente da nota fiscal	Sim
codigoTransacao	string	Código da transação da nota fiscal de saída que está sendo devolvida/cancelada	Sim
valor	double	Valor da devolução solicitado à Supplier	Sim

14.1.3 - Exemplo

{
    "cnpjCliente": "00000000000000",
    "codigoTransacao": "7475102022111",
    "valor": 160
}

14.2 - Response

14.2.1 - Campos

Atributo	Tipo	Informação
tipoRequisicao	string	Tipo da requisição
tipoEvento	string	Tipo do evento
devolucao	object	Objeto de estrutura de devolução
codigoRetorno	string	Código de retorno do processamento
mensagemRetorno	string	Mensagem de retorno do processamento
dataHoraRetorno	string	Data e hora do retorno

14.2.2 - Estrutura devolução

Atributo	Tipo	Informação
cnpjCliente	string	CNPJ/CPF do cliente
codigoTransacao	string	Código da transação
codigoSolicitacao	string	Código da solicitação
dataHoraSolicitacao	date	Data da solicitação
statusSolicitacao	string	Status da solicitação
statusSolicitacaoDesc	double	Descrição do status da solicitação
numeroNotaFiscal	string	Nùmero da nota fiscal
dataDebitoParceiro	string	Data de débito do parceiro
valorDebitoParceiro	double	Valor de débito do parceiro
valorDebitoPrincipalNF	double	Valor de débito principal
valorDebitoTaxaNF	double	Valor de débito de taxa
valorDebitoTotalNF	double	Valor de débito total
valorDevolucaoSolicitado	double	Valor de devolução solicitado
taxaEfetivacaoDebitoNF	double	Taxa efetiva do débito
dataConclusao	string	Data da conclusão no formato 'yyyy-MM-dd'
tipoRecebimentoParceiro	string	Tipo de recebimento do parceiro
parcelas	object	Objeto de estrutura de parcelas

14.2.3 - Estrutura parcelas

Atributo	Tipo	Informação
numeroParcela	int	Número da parcela
dataVencimentoParcela	string	Data de vencimento da parcela no formato 'yyyy-MM-dd'
valorDebitoPrincipalParcela	double	Valor de débito total da parcela
valorDebitoTaxaParcela	double	Valor de débito de taxa da parcela
valorDebitoTotalParcela	double	Valor de débito total da parcela
valorDevolucaoSolicitadoParcela	double	Valor de devolução solicitado da parcela
taxaEfetivacaoDebitoParcela	double	Taxa de efetivação do débito da parcela
dataDebitoParceiro	string	Data de débito do parceiro no formato 'yyyy-MM-dd'
taxasEstorno	object	Objeto de estrutura de taxas

14.2.4 - Estrutura taxas

Atributo	Tipo	Informação
idTipoTaxa	string	Identificador do tipo de taxa
tipoTaxa	string	Tipo de taxa
valorTaxa	double	Valor da taxa
valorTaxaEmReais	double	Valor da taxa em reais

14.2.5 - Exemplo

{
    "tipoRequisicao": "2",
    "tipoEvento": "1",
    "devolucao": {
        "cnpjCliente": "54029063000108",
        "codigoTransacao": "7475102022111",
        "codigoSolicitacao": "1251824",
        "dataHoraSolicitacao": "2022-12-09T09:48:09",
        "statusSolicitacao": "1",
        "statusSolicitacaoDesc": "APROVADA",
        "numeroNotaFiscal": "5102022111",
        "dataDebitoParceiro": "2022-12-12",
        "valorDebitoParceiro": 707.76,
        "valorDebitoPrincipalNF": 703.44,
        "valorDebitoTaxaNF": 4.32,
        "valorDebitoTotalNF": 707.76,
        "valorDevolucaoSolicitado": 740.00,
        "taxaEfetivacaoDebitoNF": 1.54,
        "dataConclusao": "2022-12-09",
        "tipoRecebimentoParceiro": "3",
        "parcelas": [
            {
                "numeroParcela": 1,
                "dataVencimentoParcela": "2022-12-25",
                "valorDebitoPrincipalParcela": 316.86,
                "valorDebitoTaxaParcela": 1.95,
                "valorDebitoTotalParcela": 318.81,
                "valorDevolucaoSolicitadoParcela": 333.33,
                "taxaEfetivacaoDebitoParcela": 1.54,
                "dataDebitoParceiro": "2022-12-12",
                "taxasEstorno": []
            },
            {
                "numeroParcela": 2,
                "dataVencimentoParcela": "2023-01-24",
                "valorDebitoPrincipalParcela": 316.86,
                "valorDebitoTaxaParcela": 1.95,
                "valorDebitoTotalParcela": 318.81,
                "valorDevolucaoSolicitadoParcela": 333.33,
                "taxaEfetivacaoDebitoParcela": 1.54,
                "dataDebitoParceiro": "2022-12-12",
                "taxasEstorno": []
            },
            {
                "numeroParcela": 3,
                "dataVencimentoParcela": "2023-02-23",
                "valorDebitoPrincipalParcela": 69.72,
                "valorDebitoTaxaParcela": 0.42,
                "valorDebitoTotalParcela": 70.14,
                "valorDevolucaoSolicitadoParcela": 73.34,
                "taxaEfetivacaoDebitoParcela": 1.54,
                "dataDebitoParceiro": "2022-12-12",
                "taxasEstorno": []
            }
        ]
    },
    "codigoRetorno": "000",
    "mensagemRetorno": "Solicitação processada com sucesso.",
    "dataHoraRetorno": "2023-02-13T10:56:11"
}

15 - Consulta de Pós-vendas Bonificação

15.1 - Request

15.1.1 - URL

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

15.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
codigoSolicitacao	string	Número da pós-venda que deseja-se consultar	Sim

15.1.3 - Exemplo

{
    "codigoSolicitacao": "1251824"
}

15.2 - Response

15.2.1 - Campos

Atributo	Tipo	Informação
tipoRequisicao	string	Tipo da requisição
tipoEvento	string	Tipo do evento
bonificacao	object	Objeto de estrutura de bonificacao
codigoRetorno	string	Código de retorno do processamento
mensagemRetorno	string	Mensagem de retorno do processamento
dataHoraRetorno	string	Data e hora do retorno

15.2.2 - Estrutura devolução

Atributo	Tipo	Informação
cnpjCliente	string	CNPJ/CPF do cliente
codigoTransacao	string	Código da transação
codigoSolicitacao	string	Código da solicitação
dataHoraSolicitacao	date	Data da solicitação
statusSolicitacao	string	Status da solicitação
statusSolicitacaoDesc	double	Descrição do status da solicitação
numeroNotaFiscal	string	Nùmero da nota fiscal
dataDebitoParceiro	string	Data de débito do parceiro
valorDebitoParceiro	double	Valor de débito do parceiro
valorDebitoPrincipalNF	double	Valor de débito principal
valorDebitoTotalNF	double	Valor de débito total
valorDebitoTaxaNF	double	Valor de débito de taxa
taxaEfetivacaoDebitoNF	double	Taxa efetiva do débito
dataConclusao	string	Data da conclusão no formato 'yyyy-MM-dd'
parcelas	object	Objeto de estrutura de parcelas

13.2.3 - Estrutura parcelas

Atributo	Tipo	Informação
numeroParcela	int	Número da parcela
dataVencimentoParcela	string	Data de vencimento da parcela no formato 'yyyy-MM-dd'
valorDebitoPrincipalParcela	double	Valor de débito total da parcela
valorDebitoTaxaParcela	double	Valor de débito de taxa da parcela
valorDebitoTotalParcela	double	Valor de débito total da parcela
taxaEfetivacaoDebitoParcela	double	Taxa de efetivação do débito da parcela
dataDebitoParceiro	string	Data de débito do parceiro no formato 'yyyy-MM-dd'

13.2.4 - Exemplo

{
    "tipoRequisicao": "2",
    "tipoEvento": "1",
    "bonificacao": {
        "cnpjCliente": "54029063000108",
        "codigoTransacao": "7475102022111",
        "codigoSolicitacao": "1251847",
        "dataHoraSolicitacao": "2022-12-09T11:06:19",
        "statusSolicitacao": "1",
        "statusSolicitacaoDesc": "APROVADA",
        "dataDebitoParceiro": "2022-12-12",
        "valorDebitoTotalNF": 100.0,
        "valorDebitoPrincipalNF": 100.0,
        "valorDebitoTaxaNF": 0.0,
        "taxaEfetivacaoDebitoNF": 0.0,
        "dataConclusao": "2022-12-09",
        "valorDebitoParceiro": 100.0,
        "numeroNotaFiscal": "5102022111",
        "parcelas": [
            {
                "numeroParcela": 3,
                "dataVencimentoParcela": "2023-02-23",
                "valorDebitoPrincipalParcela": 100.0,
                "valorDebitoTaxaParcela": 0.0,
                "valorDebitoTotalParcela": 100.0,
                "taxaEfetivacaoDebitoParcela": 0.0,
                "dataDebitoParceiro": "2022-12-12"
            }
        ]
    },
    "codigoRetorno": "000",
    "mensagemRetorno": "Solicitação processada com sucesso.",
    "dataHoraRetorno": "2023-03-03T07:46:48"
}

16 - Envio de Pós-Venda (Bonificação)

16.1 - Request

16.1.1 - URL

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

16.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
cnpjCliente	string	CNPJ do cliente da nota fiscal	Sim
codigoTransacao	string	Código da transação da nota fiscal de saída que está sendo devolvida/cancelada	Sim
valor	double	Valor bonificação solicitado à Supplier	Sim

16.1.3 - Exemplo

{
    "cnpjCliente": "00000000000000",
    "codigoTransacao": "7475102022111",
    "valor": 160
}

16.2 - Response

16.2.1 - Campos

Atributo	Tipo	Informação
tipoRequisicao	string	Tipo da requisição
tipoEvento	string	Tipo do evento
bonificacao	object	Objeto de estrutura de bonificação
codigoRetorno	string	Código de retorno do processamento
mensagemRetorno	string	Mensagem de retorno do processamento
dataHoraRetorno	string	Data e hora do retorno

16.2.2 - Estrutura devolução

Atributo	Tipo	Informação
cnpjCliente	string	CNPJ/CPF do cliente
codigoTransacao	string	Código da transação
codigoSolicitacao	string	Código da solicitação
dataHoraSolicitacao	date	Data da solicitação
statusSolicitacao	string	Status da solicitação
statusSolicitacaoDesc	double	Descrição do status da solicitação
dataDebitoParceiro	string	Data de débito do parceiro
valorDebitoTotalNF	double	Valor de débito total
valorDebitoPrincipalNF	double	Valor de débito principal
valorDebitoTaxaNF	double	Valor de débito de taxa
taxaEfetivacaoDebitoNF	double	Taxa efetiva do débito
dataConclusao	string	Data da conclusão no formato 'yyyy-MM-dd'
valorDebitoParceiro	double	Valor de débito do parceiro
numeroNotaFiscal	string	Nùmero da nota fiscal
parcelas	object	Objeto de estrutura de parcelas

16.2.3 - Estrutura parcelas

Atributo	Tipo	Informação
numeroParcela	int	Número da parcela
dataVencimentoParcela	string	Data de vencimento da parcela no formato 'yyyy-MM-dd'
valorDebitoPrincipalParcela	double	Valor de débito total da parcela
valorDebitoTaxaParcela	double	Valor de débito de taxa da parcela
valorDebitoTotalParcela	double	Valor de débito total da parcela
taxaEfetivacaoDebitoParcela	double	Taxa de efetivação do débito da parcela
dataDebitoParceiro	string	Data de débito do parceiro no formato 'yyyy-MM-dd'

16.2.4 - Exemplo

{
    "tipoRequisicao": "2",
    "tipoEvento": "1",
    "bonificacao": {
        "cnpjCliente": "00000000000000",
        "codigoTransacao": "7475102022111",
        "codigoSolicitacao": "1251847",
        "dataHoraSolicitacao": "2022-12-09T11:06:19",
        "statusSolicitacao": "1",
        "statusSolicitacaoDesc": "APROVADA",
        "dataDebitoParceiro": "2022-12-12",
        "valorDebitoTotalNF": 100.0,
        "valorDebitoPrincipalNF": 100.0,
        "valorDebitoTaxaNF": 0.0,
        "taxaEfetivacaoDebitoNF": 0.0,
        "dataConclusao": "2022-12-09",
        "valorDebitoParceiro": 100.0,
        "numeroNotaFiscal": "5102022111",
        "parcelas": [
            {
                "numeroParcela": 3,
                "dataVencimentoParcela": "2023-02-23",
                "valorDebitoPrincipalParcela": 100.0,
                "valorDebitoTaxaParcela": 0.0,
                "valorDebitoTotalParcela": 100.0,
                "taxaEfetivacaoDebitoParcela": 0.0,
                "dataDebitoParceiro": "2022-12-12"
            }
        ]
    },
    "codigoRetorno": "000",
    "mensagemRetorno": "Solicitação processada com sucesso.",
    "dataHoraRetorno": "2023-03-03T07:46:48"
}

17 - Consulta de Conciliações Financeiras

17.1 - Request

17.1.1 - URL

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

17.1.2 - Campos

Atributo	Tipo	Informação	Obrigatório
dataConciliacao	string	Data que se deseja realizar a consulta dos registros de conciliação 'yyyy-MM-dd'	Sim

17.1.3 - Exemplo

{
    "dataConciliacao": "2000-01-01"
}

17.2 - Response

17.2.1 - Campos

Atributo	Tipo	Informação
dataLancamentos	string	Data de consulta de conciliações no formato 'yyyy-MM-dd'
contas	object	Objeto de estrutura de contas
codigoRetorno	string	Código de retorno do processamento
mensagemRetorno	string	Mensagem de retorno do processamento
dataHoraRetorno	string	Data e hora do retorno

17.2.2 - Estrutura contas

Atributo	Tipo	Informação
razaoSocialLoja	string	Razão social da loja(cliente)
banco	string	Código do banco pertecente ao cliente
agencia	string	Número da agência pertecente ao cliente
contaCorrente	string	Conta corrente do cliente
valorSaldoNegativoAnterior	double	Valor de saldo negativo do dia anterior
valorTotalCreditos	double	Valor total de créditos lançados
valorTotalDebitos	double	valor total de débitos lançados
valorTotalLiquidoPagamento	double	Valor líquido total de recebimento
valorSaldoNegativoDia	double	Valor de saldo negativo do dia consultado
lancamentos	object	Objeto de estrutura de lançamentos

17.2.3 - Estrutura lançamentos

Atributo	Tipo	Informação
idLancamento	string	Identificador único do lançamento
tipoLancamento	string	Tipo de lançamento
tipoEvento	string	Tipo de evento
tipoEventoDesc	string	Descrição do tipo de evento
lancamentoFuturo	string	Indicador de lançamento futuro
dataLancamento	string	Data de lançamento no formato 'yyyy-MM-dd'
valorLancamento	double	Valor do lançamento
dataEvento	string	Data do evento no formato 'yyyy-MM-dd'
cnpjCliente	string	CNPJ/CPF do cliente
razaoSocialCliente	string	Razão Social do Cliente
cnpjParceiro	string	CNPJ do Parceiro
razaoSocialEmitente	string	Razão Social do emissor do lançamento
numeroNotaFiscal	string	Número da nota fiscal
codigoTransacao	string	Código da transação
tipoTransacao	string	Tipo de transação
tipoTransacaoDesc	string	Descrição do tipo de transação
codigoSolicitacao	string	Código da solicitação de Pós-vendas
valorPrincipalTransacao	double	Valor principal da transação
valorTotalTransacao	double	Valor total da transação
numeroParcelas	int	Quantidade total de parcelas
parcela	int	Número da parcela
valorPrincipalParcela	double	Valor principal da parcela
valorTotalParcela	double	Valor total da parcela
valorDevolucaoSolicitadoParcela	double	Valor de devolução solicitado da parcela
valorBaixaParcela	double	Valor de baixa da parcela
dataVencimentoOriginalParcela	string	Data de vencimento original da parcela no formato 'yyyy-MM-dd'
dataVencimentoAtualParcela	string	Data de vencimento atual da parcela no formato 'yyyy-MM-dd'
dataRecebimentoAntecipacao	string	Data de recebimento antecipado no formato 'yyyy-MM-dd'
custoAntecipacaoParcela	double	Custo de antecipação da parcela
taxaAntecipacao	double	Taxa de antecipação da parcela
tipoRecebimentoParceiro	double	Tipo de recebimento pelo parceiro

17.2.4 - Exemplo

{
    "dataLancamentos": "2023-04-14",
    "contas": [
        {
            "razaoSocialLoja": "IRMAOS FISCHER SA",
            "banco": "000",
            "agencia": "0000-0",
            "contaCorrente": "000000-0",
            "cp": "01",
            "valorSaldoNegativoAnterior": 0.0,
            "valorTotalCreditos": 11485.65,
            "valorTotalDebitos": -2490.38,
            "valorTotalLiquidoPagamento": 8995.27,
            "valorSaldoNegativoDia": 0.0,
            "lancamentos": [
                {
                    "idLancamento": "0228288420230413114155012494546001",
                    "tipoLancamento": "CREDITO",
                    "tipoEvento": "IMPL",
                    "tipoEventoDesc": "Implantação de compra",
                    "lancamentoFuturo": "N",
                    "dataLancamento": "2023-04-14",
                    "valorLancamento": 416.44,
                    "dataEvento": "2023-04-13",
                    "cnpjCpf": "00000000000000",
                    "cnpjCliente": "00000000000000",
                    "razaoSocialCliente": "270323 CLIENTE TESTE LTDA",
                    "cnpjParceiro": "00000000000000",
                    "cnpjEmitente": "00000000000000",
                    "razaoSocialEmitente": "IRMAOS FISCHER SA",
                    "numeroNotaFiscal": "21499144",
                    "codigoTransacao": "41540021499144",
                    "tipoTransacao": "0",
                    "tipoTransacaoDesc": "Compra com Cartao",
                    "valorPrincipalTransacao": 1280.42,
                    "valorTotalTransacao": 1280.42,
                    "numeroParcelas": 3,
                    "parcela": 1,
                    "valorPrincipalParcela": 426.81,
                    "valorTotalParcela": 426.81,
                    "dataVencimentoOriginalParcela": "2023-05-13",
                    "dataVencimentoAtualParcela": "2023-05-13",
                    "dataRecebimentoAntecipacao": "2023-04-14",
                    "custoAntecipacaoParcela": 10.37,
                    "taxaAntecipacao": 2.43,
                    "tipoRecebimentoParceiro": "3"
                }
            ]
        }
    ],
    "codigoRetorno": "000",
    "mensagemRetorno": "Solicitacao processada com sucesso",
    "dataHoraRetorno": "2023-05-19T17:35:57"
}