PORTAL DE DOCUMENTAÇÃO
Gestão Agro
Gestão Agro — Manual do Usuário > Agro Analytics > Gestão Safra > Integração > APIs de Integração do Gestão Safra

APIs de Integração do Gestão Safra

Confira a listagem de APIs Públicas disponíveis para integração das informações do Gestão Empresarial | ERP com a solução.

ClosedIntegrar Matriz de Distribuição

endpoint: createDistributionMatrices

ClosedJSON entrada 
{
  "matrices": [
    {
      "singleRecordKey": "string",
      "company": 0,
      "branch": 0,
      "tableNumber": 0,
      "situation": "Active",
      "initialValidity": "2023-09-21",
      "finalValidity": "2023-09-21",
      "docOrigin": "Typed",
      "matriceItems": [
        {
          "singleRecordKey": "string",
          "prioritySequence": 0,
          "distributionBranch": 0,
          "distributionCostCenter": "string",
          "accountingAccount": "string",
          "receivingCostCenter": "string",
          "distributionPercentage": 0,
          "originHarvestRecordKey": "string",
          "harvestPercentage": 0
        }
      ]
    }
  ]
}
ClosedJSON saída 
{}
ClosedIntegrar Plano de Contas

endPoint: createChartOfAccount

ClosedJSON entrada 
{
  "dataChartOfAccounts": [
    {
      "singleRecordKey": "string",
      "codeModelChart": 0,
      "descriptionModelChart": "string",
      "typeChartOfAccounts": "CT",
      "reducedAccount": "string",
      "mskGcc": "string",
      "classMskGcc": "string",
      "nomenclature": "string",
      "abbreviation": "string",
      "parallelReducedAccount": "string",
      "parallelClassification": "string",
      "parallelDescription": "string",
      "typeOfAccount": "A",
      "natureOfAccount": "D",
      "level": 0,
      "situation": "Active"
    }
  ]
}
ClosedJSON saída 
{}
ClosedIntegrar Depósito

endPoint: createDepositMovements

ClosedJSON entrada 
{
  "depositMovements": [
    {
      "singleRecordKey": "string",
      "singleRecordOriginCulture": "string",
      "singleRecordOriginHarvest": "string",
      "lastClosingDate": "2023-09-21",
      "availableForBilling": 0,
      "stockValue": "string",
      "mediumPrice": "string",
      "situation": "Active",
      "dataMovementsDeposit": [
        {
          "singleRecordKey": "string",
          "entryType": "E",
          "stockQuantity": 0,
          "singleRecordKeyMeasurementUnit": "string",
          "lastMovement": "2023-09-21"
        }
      ]
    }
  ]
}
ClosedJSON saída 
{}
ClosedIntegrar origens

Finalidade: esta API registra os projetos e suas fases, bem como as culturas de origem. Ao utilizar esta API de integração, os dados serão utilizados para informar o campo Origem de Cultura da tela Culturas.

endpoint: createOrigins

ClosedJSON entrada 
{
  "origins": [
    {
      "singleRecordKey": "string",
      "code": "string",
      "description": "string",
      "situation": "Active",
      "applicationOrigin": "SeniorERP",
      "type": "HARVEST",
      "parentSingleRecordKey": "string"
    }
  ]
}
ClosedJSON saída 
{}
ClosedIntegrar Origens de Classificação

endPoint: createOriginClassification

ClosedJSON entrada 
{
  "classifications": [
    {
      "singleRecordKey": "string",
      "description": "string"
    }
  ]
}
ClosedJSON saída 
{}
ClosedIntegrar Origens de Classificação de Grãos

endPoint: createOriginGrainClassification

ClosedJSON entrada 
{
  "grainClassifications": [
    {
      "situation" : "Inactive" or "Active",
      "singleRecordKey": "string",
      "singleRecordKeyOriginHarvest": "string",
      "singleRecordKeyOriginCulture": "string",
      "singleRecordKeyOriginLocalization": "string",
      "singleRecordKeyOriginClassification": "string",
      "singleRecordKeyMeasurementUnit": "string"
      "value": 0,
      "discountValue": 0,
    }
  ]
}
ClosedJSON saída 
{}
ClosedIntegrar Faturamento

Finalidade: responsável por receber e cadastrar os dados de faturamento.

endPoint: createInvoice

Observação
  • Ao receber os dados, esse endpoint irá retornar um protocolo na requisição. Esse protocolo será utilizado para consulta de status da requisição.
  • Caso a nota fiscal e seus impostos já estiverem integrados com a plataforma e o usuário, por meio do ERP, realizar quaisquer movimentação de abertura desta nota fiscal, a mesma será integrada com a plataforma e seus impostos serão removidos/excluídos e a nota será considerada como não consolidada. Para que a plataforma entenda que esta nota seja caracterizada como consolidada, o usuário deverá novamente efetuar a operação de consolidação dos impostos no ERP, que por sua vez integrará estes impostos com a plataforma.
ClosedJSON entrada 
{
{
  "invoices": [
    {
      "singleRecordKey": "string",
      "number": 0,
      "series": 0,
      "issueData": "2023-09-21",
      "situation": "TYPED",
      "situationNfe": "AUTHORIZED",
      "client": "string",
      "grossValue": "string",
      "itemsInvoices": [
        {
          "singleRecordKey": "string",
          "referenceProduct": "string",
          "descriptionProduct": "string",
          "salesQuantity": 0,
          "grossValue": "string",
          "netValue": "string",
          "singleRecordKeyOriginCulture": "string",
          "singleRecordKeyOriginDeposit": "string",
          "discountValue": "string"
        }
      ],
      "assessment": [
        {
          "singleRecordKey": "string",
          "costCenter": "string",
          "value": "string",
          "singleRecordKeyProject": "string",
          "singleRecordKeyFase": "string",
          "percProjPhase": 0,
          "percCDC": 0,
          "singleRecordKeyItemInvoice": "string"
        }
      ],
      "invoiceFinality": "INVOICING",
      "discountValue": "string",
      "singleRecordKeyOriginHarvest": "string"
    }
  ]
}
ClosedJSON saída 
{	
  "protocol": "string"
}
ClosedCadastrar Lotes

endPoint: createAccountingLots

ClosedJSON entrada 
{
  "accountingLots": [
    {
      "lotSingleRecordKey": "string",
      "lotNumber": 0,
      "matrixSingleRecordKey": "string",
      "situation": "Active",
      "entries": [
        {
          "entrySingleRecordKey": "string",
          "entryNumber": 0,
          "entryDate": "2023-09-21",
          "origin": "MAN",
          "entryType": "ACCOUNTING",
          "lotValue": "string",
          "debitAccount": "string",
          "creditAccount": "string",
          "assessments": [
            {
              "assessmentSingleRecordKey": "string",
              "accountingAccount": "string",
              "costCenter": "string",
              "percentage": 0,
              "value": "string",
              "debitOrCredit": "D"
            }
          ]
        }
      ]
    }
  ]
}
ClosedJSON saída 
{}
ClosedVincular impostos

endPoint: createTaxInvoice

ClosedJSON entrada 
{
  "taxInvoiceGroups": [
    {
      "singleRecordKeyInvoice": "string",
      "taxValue": "string"
    }
  ]
}
ClosedJSON saída 
{}
ClosedConsultar Protocolos

endPoint: getProcessedRecords

ClosedJSON entrada 
{
  "protocols": [
    {
      "protocol": "string"
    }
  ]
}

O campo protocol é o id retornado ao fazer a requisição do endpoint createAccountingLots.

ClosedJSON saída 
{
  "returnProtocols": [
    {
      "protocol": "string",
      "statusProtocol": "SUCCESS",
      "returnProcessing": [
        {
          "singleRecordKey": "string",
          "errorMessage": {
            "message": "string"
          },
          "status": "SUCCESS"
        }
      ]
    }
  ]
}
ClosedReceber dados de unidade de medida

Finalidade: receber as informações de unidades de medidas utilizadas pelo sistema de Gestão Empresarial | ERP. Essas informações serão utilizadas na configuração das regras de conversão e na geração das consolidações.

endpoint: createMeasurementUnits

ClosedJSON entrada 
{
  "measurementUnits": [
    {
     "singleRecordKey": "string",
     "description": "string",
     "acronym": "string"
    }
  ]
}
ClosedJSON saída 
{}
ClosedReceber os insumos e a lista de rateio

Finalidade: recepcionar os insumos e a lista de rateio de cada insumo.

endpoint: createFeedStockAssessments

Importante

Esta API irá popular duas tabelas:

  • feed_stock_assessment: para gravar o cabeçalho do insumo.
  • details_feed_stock_assessment: para gravar os detalhes de rateio de cada insumo.
ClosedJSON entrada 
{
  "feedStockAssessments": [
    {
      "singleRecordKey": "string",
      "situation": "Active",
      "singleRecordKeyOriginHarvest": "string",
      "singleRecordKeyFeedStock": "string",
      "singleRecordKeyMeasurementUnit": "string",
      "assessmentItems": [
        {
          "singleRecordKeyOriginProject": "string",
          "singleRecordKeyOriginPhase": "string",
          "assessmentPercentagePhase": 0,
          "singleRecordKeyOriginCostCenter": "string",
          "assessmentPercentageCostCenter": 0,
          "amount": 0,
          "value": "string"
        }
      ]
    }
  ]
}{
  "classifications": [
    {
      "singleRecordKey": "string",
      "description": "string"
    }
  ]
}
ClosedJSON saída 
{}

Este artigo ajudou você?

Base de Conhecimento

Portal de Exigências Legais

Contrato de Licenciamento de Software e Prestação de Serviços

Documentação em outros idiomas:

English

Español

Senior Store

Universidade Corporativa

Fórum de Produtos

Trabalhe conosco

Blog

Todos os direitos de cópias reservadas para Senior Sistemas S.A.

A reprodução não autorizada desta publicação, no todo ou em parte, constitui violação dos direitos autorais (Lei 9.610/98).

Ver site completo