Consulta de conferências via API GET

Consulta a nível de EPC

Esse endpoint permite, através de um GET HTTP no caminho /conference/epc consultar os EPCs conferidos:

curl 'http://SERVER:PORT/api/conference/epc?pageIndex=0&pageSize=10&conferenceType=RECEIPT&startDocumentDate=2024-10-16&endDocumentDate=2024-10-16'
-H 'Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4'

Resposta em caso de sucesso

{
  "items": [
    {
      "id": "ffd41730-3c9c-482d-a5bc-9e5e0ba7bb36C08100300000000006010001",
      "documentId": "e40ee0b8-6af0-4e37-9232-a55f8f6594c0",
      "documentReference": "PED0000033",
      "documentDescription": "SAIDA-OESTE-02/12/2024-COD: 100300000000006-TELEFONE SEM FIO DE LONGO ALCANCE MODELO DURAFON 1X",
      "documentBatch": null,
      "documentDate": "2024-12-02",
      "conferenceType": "DISPATCH",
      "conferenceStatus": "DONE",
      "conferenceDate": "2024-12-02 16:35:34",
      "epcId": "8760dd5d-45b5-49c7-b309-8e2100026514",
      "epc": "C08100300000000006010001",
      "batch": null,
      "fraction": 1.0,
      "placeId": null,
      "placeReference": null,
      "placeName": null,
      "costcenterId": null,
      "costcenterReference": null,
      "costcenterName": null,
      "productId": "5760dd5d-45b5-49c7-b309-8e2100011614",
      "productReference": "100300000000006",
      "productDescription": "100300000000006 - TELEFONE SEM FIO DE LONGO ALCANCE MODELO DURAFON 1X",
      "supplierId": "ff8f84c2-2061-4649-a32e-4aa5b646577d",
      "supplierReference": "00000804",
      "supplierName": "ITUMBIARA TRANSMISSORA DE ENERGIA S.A.",
      "customerId": "5c711c81-7f30-46e6-83dc-911a0ee40125",
      "customerName": "ITUMBIARA TRANSMISSORA DE ENERGIA S.A.",
      "customerReference": "00000802",
      "conferenceCustom": null,
      "documentCustom": {
        "ativo": false,
        "saida_nf": false,
        "hasReserve": false,
        "integracao": true,
        "observacao": "SAIDA-OESTE-02/12/2024-COD: 100300000000006-TELEFONE SEM FIO DE LONGO ALCANCE MODELO DURAFON 1X",
        "tipo_saida": "CONSUMO",
        "num_armazem": "003",
        "tipo_armazem": "CONS",
        "data_retirada": "2024-12-02",
        "id_integracao": "Sem Movimento",
        "status_protheus": "ACEITO"
      },
      "productCustom": {},
      "epcCustom": null,
      "placeCustom": null,
      "costCenterCustom": null,
      "invoiceProductCustom": {},
      "supplierCustom": {}
    }
  ]
}

Consulta a nível de Produto

Esse endpoint permite, através de um GET HTTP no caminho /conference/product consultar os Produtos conferidos:

curl 'http://SERVER:PORT/api/conference/product?pageIndex=0&pageSize=10&conferenceType=RECEIPT' \
-H 'Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4'

Resposta em caso de sucesso

{
  "items": [
    {
      "id": "f48f3c6b-fafb-4ede-957d-225ad3fbc535303800258000647FF5655C2A",
      "documentId": "f48f3c6b-fafb-4ede-957d-225ad3fbc535",
      "documentReference": "011297",
      "documentDescription": "Ordem de Beneficiamento 011297",
      "documentBatch": "1234/2024",
      "documentDate": "2024-03-28",
      "conferenceType": "RECEIPT",
      "conferenceId": "f48f3c6b-fafb-4ede-957d-225ad3fbc535",
      "conferenceDate": "2023-09-15 09:42:55",
      "placeId": "f48f3c6b-fafb-4ede-957d-225ad3fbc535",
      "placeReference": "0000",
      "placeName": "0000 - Local Padrão",
      "supplierId": "f48f3c6b-fafb-4ede-957d-225ad3fbc535",
      "supplierReference": "0000",
      "supplierName": "0000 - Fornecedor",
      "productId": "f48f3c6b-fafb-4ede-957d-225ad3fbc535",
      "productReference": "150000401",
      "productDescription": "150000401 - FIO AP-150 PRETO",
      "count_epc": 123,
      "sum_fraction": 123.25,
      "documentCustom": {
        "campoCustomDocument": true
      },
      "conferenceCustom": {
        "campoCustomConference": 456
      },
      "placeCustom": {
        "campoCustomPlace": false
      },
      "productCustom": {
        "campoCustomProduct": "teste"
      },
      "supplierCustom": {
        "campoCustomSupplier": 10.6
      },
      "invoiceProductCustom": {
        "valor_unitario": 100
      }
    }
  ]
}

Descrição dos campos

Campos das duas APIs:

• documentId - Identificador do documento conferido
• documentReference - Código do documento conferido
• documentDescription - Descrição do documento conferido
• documentDate - Data do documento conferido
• documentBatch - Lote do documento conferido
• conferenceDate - Data e Hora da conferência
• conferenceType - Tipo da conferência:
  • RECEIPT - Entrada
  • TRANSFER - Transferência de produto acabado
  • RAW_TRANSFER- Transferência de matéria prima
  • DISPATCH - Saída de produto acabado
• conferenceStatus - Status da conferência:
  • DONE - Concluído
  • DONE_PARTIAL - Conclusão Parcial
  • IN_PROGRESS- Em andamento
• conferenceId - Identificador da conferência
• productId - Identificador do produto do EPC conferido
• productReference - Código(SKU) do produto do EPC conferido
• productDescription - Descrição do produto do EPC conferido
• placeId - Identificador do Local da conferência
• placeReference - Código do Local da conferência
• placeName - Nome local da conferência
• supplierId - Identificador do Fornecedor da conferência
• supplierReference - Código do Fornecedor da conferência
• supplierName - Nome Fornecedor da conferência
• documentCustom - Campos personalizados da tabela de Documento
• conferenceCustom - Campos personalizados da tabela de Conferência
• placeCustom - Campos personalizados da tabela de Local
• productCustom - Campos personalizados da tabela de Produto
• supplierCustom - Campos personalizados da tabela de Fornecedor
• invoiceProductCustom - Campos personalizados da tabela de Itens do Documento

Somente na API /conference/epc:

• epcId - Identificador do EPC conferido
• epc - EPC conferido
• costCenterId - Identificador do centro de custo do epc conferido
• costCenterReference - Código do centro de custo do epc conferido
• costCenterName - Nome local de destino do centro de custo do epc conferido
• batch - Lote do EPC conferido
• fraction - Fração do EPC conferido
• epcCustom - Campos personalizados da tabela de Produto
• costCenterCustom - Campos personalizados da tabela de Centro de Custo

Somente na API /conference/product:

• countEpc - Total de EPCs conferidos desse produto
• sumFraction - Somatório das frações dos EPCs conferidos desse produto

Resposta em caso de erro

{
    "errorMessage": "Mensagem de erro"
}

Autenticação

A chamada para esses endpoints necessitam autenticação do tipo Basic(Base64 encoded) com credenciais de um usuário devidamente cadastrado no sistema Valesoft. Ex: Usuário integração com senha 12345678

• integração:12345678 => Base64 encoded => aW50ZWdyYcOnw6NvOjEyMzQ1Njc4
• Header de autenticação => Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4

Parâmetros da requisição:

• SERVER - O IP ou DNS do servidor onde o sistema Valesoft está instalado
• PORT - A porta definida na instalação do sistema.
• pageIndex - Índice da página atual de resultado, iniciando em 0
• pageSize - Quantidade de itens da página atual de resultado

Parâmetros da requisição da API /conference/epc:

• startDocumentDate - Filtro de data inicial do documento.(Não obrigatório)
• endDocumentDate - Filtro de data final do documento.(Não obrigatório)

Filtragem dos resultados

É possível filtrar através de parâmetros query quaisquer campos presentes no resultado da api, incluindo campos personalizadas das tabelas envolvidas, como no exemplo cURL acima onde é filtrado o tipo de conferência com &conferenceType=RECEIPT.