APIs de Integração do Posiçã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.
Integrar Culturas
Finalidade: Registra as culturas de origem. Ao utilizar essa API de integração, os dados serão utilizados para informar o campo Origem de Cultura da tela Culturas.
endpoint: createOriginCultures
JSON entrada
{"cultures": [
{ "singleRecordKey": "string",
"code": "string",
"description": "string",
"type": "CDC", "FP", "CE",
"origin": "SeniorERP",
"situation": "Active"
}
]
}
JSON saída
{}
Integrar Safras
endpoint: createOriginHarvests
JSON entrada
{"originHarvests":[
{"code":"1",
"origin":"SeniorERP",
"type":"CD",
"description":"2021/2022",
"situation":"Active",
"singleRecordKey":"1"
}
]
}
Pode ser realizado o cadastro de mais de uma origem, conforme exemplo abaixo:
{"originHarvests":[
{"code":"1",
"origin":"SeniorERP",
"type":"CD",
"description":"2020/2021",
"situation":"Active",
"singleRecordKey":"1"
},
{"code":"2",
"origin":"OtherSources",
"type":"CD",
"description":"2020/2021",
"situation":"Active",
"singleRecordKey":"2"
}
]
}
JSON saída
{}
Integrar Matriz de Distribuição
endpoint: createDistributionMatrices
JSON entrada
{"matrices": [
{"singleRecordKey": "string",
"company": 0,
"branch": 0,
"tableNumber": 0,
"situation": "Active",
"initialValidity": "2022-10-11",
"finalValidity": "2022-10-11",
"docOrigin": "Typed",
"matriceItems": [
{"singleRecordKey": "string",
"prioritySequence": 0,
"distributionBranch": 0,
"distributionCostCenter": "string",
"accountingAccount": "string",
"receivingCostCenter": "string",
"distributionPercentage": 0,
"originHarvestRecordKey": "string",
"harvestPercentage": 0
}
]
}
]
}
JSON saída
{}
Integrar Plano de Contas
endPoint: createChartOfAccount
JSON 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"
}
]
}
JSON saída
{}
Integrar Depósito
endPoint: createDepositMovements
JSON entrada
{"depositMovements": [
{"singleRecordKey": "string",
"singleRecordCulture": "string",
"singleRecordHarvest": "string",
"lastClosingDate": "2022-12-09",
"availableForBilling": 0,
"stockValue": "string",
"mediumPrice": "string",
"situation": "Active",
"dataMovementsDeposit": [
{"singleRecordKey": "string",
"entryType": "E",
"stockQuantity": 0,
"measurementUnit": "BUSHEL",
"lastMovement": "2022-12-09"
}
]
}
]
}
JSON saída
{}
Receber Cadastros de Projetos e Fases
endPoint: CreateProjects
Finalidade: Registra os projetos
JSON entrada
{"projects":[
{"SingleRecordKey": "string",
"number": "0",
"description": "string",
"abbreviation": "string",
"situation": "Active",
"branch": "0",
"predictionStartDate": "2022-08-29",
"predictionFinalDate": "2022-08-29"
}
]
}
JSON saída
{}
endPoint: CreatePhases
Finalidade: Registra as fases do projeto
JSON entrada
{"phases":[
{"SingleRecordKey": "string",
"SingleRecordProject": "string",
"number": "0",
"description": "string",
"abbreviation": "string",
"situation": "Active",
"predictionStartDate": "2022-08-29",
"predictionFinalDate": "2022-08-29"
"singleRecordKeyPhaseSynthetic": "string",
"type": "A"
}
]
}
JSON saída
{}
Integrar 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.
JSON entrada
{
"invoices": [
{
"singleRecordKey": "170;1;NFE;126",
"number": 126,
"series": 1,
"issueData": "2022-12-01",
"situation": "CLOSE",
"situationNfe": "AUTHORIZED",
"client": "Cliente com ICMS e IPI",
"grossValue": 31487.1,
"singleRecordKeyOriginHarvest": "170;SAFRA 2023;Safra",
"itemsInvoices": [
{
"singleRecordKey": "170;1;NFE;126;1",
"referenceProduct": "CEV0001",
"descriptionProduct": "CEVADA CONVENCIONAL",
"salesQuantity": 1500,
"grossValue": 31487.1,
"netValue": 30841.61,
"singleRecordKeyOriginCulture": "170;CEVADA;Familia",
"singleRecordKeyOriginDeposit": "170;1;Deposito"
}
],
"assessment": [
{
"singleRecordKey": "170;1;NFE;126;1",
"costCenter": "170;3232;CentroCusto",
"value": 30841.61,
"singleRecordKeyProject": "170;12",
"singleRecordKeyFase": "170;12;1",
"percProjPhase": 100.0,
"percCDC": 100.0
}
],
"invoiceFinality": "INVOICING",
"discountValue": 645.49
}
]
}
JSON saída
{
"protocol": "string"
}
Cadastrar Lotes
endPoint: createAccountingLots
JSON entrada
{"accountingLots":[
{"lotSingleRecordKey": "1",
"lotNumber": 1,
"matrixSingleRecordKey": "1",
"situation": "Active",
"entries": [
{"entrySingleRecordKey": "1",
"entryNumber": 2,
"entryDate": "2022-05-04",
"origin": "MAN",
"entryType": "ACCOUNTING",
"lotValue": 100.50,
"debitAccount": "1",
"creditAccount": "1",
"assessments": [
{"assessmentSingleRecordKey": "1",
"accountingAccount": "1",
"costCenter": "1",
"percentage": 10.0,
"value": 100,
"debitOrCredit": "D"
}
]
}
]
}
]
}
JSON saída
{ "protocol": "c0708d36-c99b-4a81-8bf5-243a30316342"
}
Ativar ou Inativar Lotes
endPoint: createAccountingLots
JSON entrada
{"accountingLots":[
{"lotSingleRecordKey": "1",
"situation": "Inactive",
}
]
}
JSON saída
{
"protocol": "c0708d36-c99b-4a81-8bf5-243a30316342"
}
Vincular impostos
endPoint: createTaxInvoice
JSON entrada
{"taxInvoiceGroups": [
{"singleRecordKeyInvoice": "170;1;NFE;117",
"taxValue": 157.35
}
]
}
JSON saída
{}
Consultar Protocolos
endPoint: getProcessedRecords
JSON entrada
{"protocols": [
{"protocol": "60aaa3d0-2dfc-4cfe-9f01-ecb568dfee2d"
},
{"protocol": "c0708d36-c99b-4a81-8bf5-243a30316342"
}
]
}
O campo protocol é o id retornado ao fazer a requisição do endpoint createAccountingLots.
JSON saída
{"returnProtocols": [
{"protocol": "12463ea2-039d-4533-80f8-ab75ad25456a",
"statusProtocol": "ERROR",
"returnProcessing": [
{"singleRecordKey": "11",
"errorMessage": {"message": "agro.posicaosafra.chart_of_accounts_not_found, []"
},
"statusProtocol": "ERROR"
},
{"singleRecordKey": "12",
"status": "SUCCESS"
}
]
}
]
}
Receber 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: measurementUnits
JSON entrada
{"measurementUnits": [
{"singleRecordKey": "string",
"description": "string",
"acronym": "string"
}
]
}
JSON saída
{}
Integrar cadastro de insumos utilizados na safra
Finalidade: integrar ao sistema o cadastro de insumos utilizados na safra e/ou cultura.
endpoint: createOriginFeedStocks
JSON entrada
{
"originFeedStocks": [
{
"singleRecordKey": "1;2;4",
"description": "unidade teste 4",
"measurementUnit": {
"singleRecordKey": "1234"
"description": "Quilos",
"acronym": "KG"
}
}
]
}
JSON saída
{}
Receber 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.
JSON entrada
{
"feedStockAssessments": [
{
"singleRecordKey": "1;1;1",
"situation": "Active",
"singleRecordKeyFeedStock": "1;2;4",
"singleRecordKeyMeasurementUnit": "1;2;4",
"assessmentItems": [
{
"singleRecordKeyProject": "170;6",
"singleRecordKeyPhase": "170;6;1",
"assessmentPercentagePhase": 1,
"singleRecordKeyCostCenter": "170;3170;CentroCusto",
"assessmentPercentageCostCenter": 12,
"amount": 1,
"value": "1"
},
{
"singleRecordKeyProject": "170;6",
"singleRecordKeyPhase": "170;6;1",
"assessmentPercentagePhase": 1,
"singleRecordKeyCostCenter": "170;3170;CentroCusto",
"assessmentPercentageCostCenter": 12,
"amount": 1,
"value": "1"
},
{
"singleRecordKeyProject": "170;6",
"singleRecordKeyPhase": "170;6;1",
"assessmentPercentagePhase": 1,
"singleRecordKeyCostCenter": "170;3170;CentroCusto",
"assessmentPercentageCostCenter": 12,
"amount": 1,
"value": "1"
}
]
}
]
}
JSON saída
{}
English
Español
