Consultar parceiros

Consulte parceiros cadastrados Sankhya ERP através da API de serviços

Campo

Tipo

Descrição

Conta de serviço

Select

Permite o acesso ao sistema através de credenciais fornecidas no painel de contas do Floui.

Campo

String

Atributo interno do ERP.

Valor

String

Valor a ser consultado.

Tipo do valor

Select

Tipo de operação.

Campos para retorno na consulta

String

Permite selecionar os campos necessários para a consulta.

Número de resultados por página

String

Define um número de itens por cada página.

Página atual

String

Permite exibir uma página por padrão.

Retorno em modo simplificado

Select

Define uma máscara simplificada abstraindo informações da requisição original.

Output path

String

Armazena os dados de saída do conector ao final da execução.

Descrição

String

Mensagem visual usada para descrever a funcionalidade do conector dentro do fluxo.

Consulta de Clientes

get

Regras de negócio

Para realizar a consulta de clientes é necessário definir as funções do parceiro no sistema.Quando você incluir um novo registro do tipo clientes ou mesmo duplicar algum já existente ao salvar este novo registro, o sistema mantém tais opções desmarcadas, ou seja, o novo cadastro não terá seu tipo definido automaticamente.
OBS: Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:
https://ajuda.sankhya.com.br/hc/pt-br/articles/360044594494-Cadastro-de-Parceiroso

Dependências

Não possui dependências

Detalhes Técnicos

A entidade utilizada é a Parceiro que por sua vez instancia a tabela TGFPAR mapeando os campos principais.
Para realizarmos a busca através do Json, utilizamos o serviço "CRUDServiceProvider.loadRecords".

O serviço CRUDServiceProvider.loadRecords é um otimo serviço para ser utilizado para consulta de dados através do JSON.

No exemplo abaixo foi utilizado como filtro os campos CODPARC e CLIENTE, porém você pode utilizar outros campos da entidade .

Para utilizar o filtro, basta acrescentar o corpo da requisição o código abaixo utilizando o criteria:

    "criteria": {
                "expression": {
                  "this.CLIENTE = 'S' and this.CODPARC = 648"
                }
              }

Para melhor performance sempre utilize nas suas consultas apenas os campos necessários, para evitar tráfego de dados que não serão utilizados.

Descritivo de campos da entidade

Acesse aqui o dicionário de dados da tabela TGFPAR

Exemplo de uso:

URL de chamada: https://api.sankhya.com.br/gateway/v1/mge/service.sbr?serviceName=CRUDServiceProvider.loadRecords&outputType=json

Corpo de requisição

{
  "serviceName": "CRUDServiceProvider.loadRecords",
  "requestBody": {
    "dataSet": {
      "rootEntity": "Parceiro",
      "includePresentationFields": "N",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.CODPARC = 648 AND CLIENTE = 'S'"
        }
      },
      "entity": {
        "fieldset": {
          "list": "CODPARC,NOMEPARC,FORNECEDOR,CLIENTE,CODCID,CLIENTE,CLASSIFICMS"
        }
      }
    }
  }
}

Retorno em json:

{
  "serviceName": "CRUDServiceProvider.loadRecords",
  "status": "1",
  "pendingPrinting": "false",
  "transactionId": "11045006CD6E63CFD528873AA09448AE",
  "responseBody": {
      "entities": {
          "total": "1",
          "hasMoreResult": "false",
          "offsetPage": "0",
          "offset": "0",
          "entity": {
              "f1": {
                  "$": "TESTE123"
              },
              "f0": {
                  "$": "648"
              },
              "f3": {
                  "$": "S"
              },
              "f2": {
                  "$": "S"
              },
              "f5": {
                  "$": "C"
              },
              "f4": {
                  "$": "10"
              }
          },
          "metadata": {
              "fields": {
                  "field": [
                      {
                          "name": "CODPARC"
                      },
                      {
                          "name": "NOMEPARC"
                      },
                      {
                          "name": "FORNECEDOR"
                      },
                      {
                          "name": "CLIENTE"
                      },
                      {
                          "name": "CODCID"
                      },
                      {
                          "name": "CLASSIFICMS"
                      }
                  ]
              }
          }
      }
  }

}

Responses

201

Consulta efetuada com sucesso

No content

400

Requisição inválida

500

Erro interno do servidor

get/Clientes

GET /Clientes HTTP/1.1
Accept: */*

No content

Consulta de Fornecedores

get

Regras de negócio

Para realizar a consulta de fornecedores é necessário definir as funções do parceiro no sistema.Quando você, incluir um novo registro do tipo fornecedor ou mesmo duplicar algum já existente ao salvar este novo registro, o sistema mantém tais opções desmarcadas, ou seja, o novo cadastro não terá seu tipo definido automaticamente.
OBS: Caso tenha alguma necessidade de configuração do ERP procure “Consultor” ou acesso o link de apoio:
https://ajuda.sankhya.com.br/hc/pt-br/articles/360044594494-Cadastro-de-Parceiros

Dependências

Não possui dependências

Detalhes Técnicos

A entidade utilizada é a Parceiro que por sua vez instancia a tabela TGFPAR mapeando os campos principais.
Para realizarmos a busca através do Json, utilizamos o serviço "CRUDServiceProvider.loadRecords".

O serviço CRUDServiceProvider.loadRecords é um otimo serviço para ser utilizado para consulta de dados através do JSON.

No exemplo abaixo foi utilizado como filtro os campos CODPARC e FORNECEDOR, porém você pode utilizar outros campos da entidade .

Para utilizar o filtro, basta acrescentar o corpo da requisição o código abaixo utilizando o criteria:

    "criteria": {
                "expression": {
                  "this.FORNECEDOR = 'S' and this.CODPARC = 566"
                }
              }

Para fins de performance na busca de dados, uzilize apenas os campos pertinentes a sua busca, quanto mais campos forem inseridos no corpo da requisição, poderá haver perda de performance no retono dos dados solicitados.

Descritivo de campos da entidade

Acesse aqui o dicionário de dados da tabela TGFPAR

Exemplo de uso:

URL de chamada: https://api.sankhya.com.br/gateway/v1/mge/service.sbr?serviceName=CRUDServiceProvider.loadRecords&outputType=json

Corpo de requisição

{
  "serviceName": "CRUDServiceProvider.loadRecords",
  "requestBody": {
    "dataSet": {
      "rootEntity": "Parceiro",
      "includePresentationFields": "N",
      "offsetPage": "0",
      "criteria": {
        "expression": {
          "$": "this.CODPARC = 648 AND FORNECEDOR = 'S'"
        }
      },
      "entity": {
        "fieldset": {
          "list": "CODPARC,NOMEPARC,FORNECEDOR,CLIENTE,CODCID,CLIENTE,CLASSIFICMS"
        }
      }
    }
  }
}

Retorno em json:

{
  "serviceName": "CRUDServiceProvider.loadRecords",
  "status": "1",
  "pendingPrinting": "false",
  "transactionId": "11045006CD6E63CFD528873AA09448AE",
  "responseBody": {
      "entities": {
          "total": "1",
          "hasMoreResult": "false",
          "offsetPage": "0",
          "offset": "0",
          "entity": {
              "f1": {
                  "$": "TESTE123"
              },
              "f0": {
                  "$": "648"
              },
              "f3": {
                  "$": "S"
              },
              "f2": {
                  "$": "S"
              },
              "f5": {
                  "$": "C"
              },
              "f4": {
                  "$": "10"
              }
          },
          "metadata": {
              "fields": {
                  "field": [
                      {
                          "name": "CODPARC"
                      },
                      {
                          "name": "NOMEPARC"
                      },
                      {
                          "name": "FORNECEDOR"
                      },
                      {
                          "name": "CLIENTE"
                      },
                      {
                          "name": "CODCID"
                      },
                      {
                          "name": "CLASSIFICMS"
                      }
                  ]
              }
          }
      }
  }

}

Responses

201

Cadastro efetuado com sucesso

No content

400

Requisição inválida

500

Erro interno do servidor

get/fornecedor

GET /fornecedor HTTP/1.1
Accept: */*

No content

PreviousParceiro NextPedido

Last updated 2 years ago

Was this helpful?