agro (Agronegócio)

2.0info: 2.1.1 App do produtor rural description: Gestão do App do Produtor x-senior-domain: Agronegócio x-senior-domain-path: agro x-senior-service-path: agrox contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /agro/agrox/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /createProducerReceived: post: description: Cadastra os produtores ### Resources - res://senior.com.br/agro/agrox/actions/createProducerReceived x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – producers properties: producers: type: array items: #/definitions/producersReceived description: Lista de produtores responses: 200: description: Ok schema: type: object required: – protocol properties: protocol: type: string description: Protocolo de retorno, que será utilizado para consultar o status da requisição, através do método getProcessedRecords 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /getProcessedRecords: post: description: Lista o status de cada protocolo de requisição ### Resources - res://senior.com.br/agro/agrox/queries/getProcessedRecords x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – protocols properties: protocols: type: array items: #/definitions/protocols description: Lista de protocolos que serão utilizados para consulta de status responses: 200: description: Ok schema: type: object required: – returnProtocols properties: returnProtocols: #/definitions/returnProtocols default: description: Error response schema: #/definitions/genericError /createFinancialRecord: post: description: Registra os contas a pagar e contas a receber ### Resources - res://senior.com.br/agro/agrox/actions/createFinancialRecord x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – financialRecords properties: financialRecords: type: array items: #/definitions/financialRecords description: Lista de titulos financeiros responses: 200: description: Ok schema: type: object required: – protocol properties: protocol: type: string description: Protocolo de retorno, que será utilizado para consultar o status da requisição, através do método getProcessedRecords 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /createQuotesReceived: post: description: Registra as cotações ### Resources - res://senior.com.br/agro/agrox/actions/createQuotesReceived x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – quotes properties: quotes: type: array items: #/definitions/quotesReceived description: Lista de cotações responses: 200: description: Ok schema: type: object required: – protocol properties: protocol: type: string description: Protocolo de retorno, que será utilizado para consultar o status da requisição, através do método getProcessedRecords 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /createTriggerExternalNotifications: post: description: Dispara notificações ### Resources - res://senior.com.br/agro/agrox/actions/createTriggerExternalNotifications x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – externalNotifications properties: externalNotifications: type: array items: #/definitions/externalNotification description: Lista de destinatários e informações que serão utilizadas na geração das notificações responses: 200: description: Ok schema: type: object required: – protocol properties: protocol: type: string description: Protocolo de retorno, que será utilizado para consultar o status da requisição, através do método getProcessedRecords 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /createPhysicalTransactions: post: description: Registra as Movimentação Fisicas ### Resources - res://senior.com.br/agro/agrox/actions/createPhysicalTransactions x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – dataReceived properties: dataReceived: type: array items: #/definitions/physicalTransactionReceived description: Lista das movimentações físicas responses: 200: description: Ok schema: type: object required: – protocol properties: protocol: type: string description: Protocolo de retorno, que será utilizado para consultar o status da requisição, através do método getProcessedRecords 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericError /createQuotasReceived: post: description: Registra as cotas ### Resources - res://senior.com.br/agro/agrox/actions/createQuotasReceived x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – quotas properties: quotas: type: array items: #/definitions/quotasReceived description: Lista das cotas responses: 200: description: Ok schema: type: object required: – protocol properties: protocol: type: string description: Protocolo de retorno, que será utilizado para consultar o status da requisição, através do método getProcessedRecords 403: description: Permissão negada 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericErrordefinitions: ENumTipoOperacaoCrud: type: string enum: – CREATE – UPDATE – DELETE ENumTabelaSync: type: string enum: – CP – CR – COTAS situacaoProdutor: type: string enum: – INATIVO – ATIVO statusRegistrosProcessados: type: string enum: – SUCESSO – ERRO – PENDENTE quotasReceived: type: object required: – singleRecordKey – cpfCnpj – valueQuota – valueQuotaPaidIn properties: singleRecordKey: type: string description: Chave unica do registro de cotas cpfCnpj: type: string description: Cpf/Cnpj do produtor referente a cota valueQuota: type: number description: Valor da cota parte format: double valueQuotaPaidIn: type: number description: Valor da cota integralizada format: double financialRecords: type: object required: – singleRecordKey – cpfCnpj – typeOperationCrud – tableSync properties: singleRecordKey: type: string description: Chave unica do registro financeiro cpfCnpj: type: string description: Cpf/Cnpj do Produtor referente ao titulo financeiro numberTitle: type: string description: Numero de identificação do titulo typeTitle: type: string description: Tipo do titulo (Adiantamento, Duplicada, etc…) maturityDate: type: string description: Data de vencimento format: date-time valueTitle: type: string description: Valor do titulo situationTitle: type: string description: Situação do titulo (AB – Aberto, LQ – Liquidado, LS – Liquidado por Substituição) dateOfIssue: type: string description: Data de Emissão format: date-time nameCoin: type: string description: Nome da moeda vinculada ao titulo quoteCoin: type: string description: Cotação da moeda vinculada ao titulo valueCoin: type: string description: Valor da moeda openAmount: type: string description: Valor em aberto do titulo typeOperationCrud: #/definitions/ENumTipoOperacaoCrud tableSync: #/definitions/ENumTabelaSync quotesReceived: type: object required: – codeCoin – description – dateQuote – previsionQuote – quote – singleRecordKey – initialsCoin properties: codeCoin: type: string description: Codigo da moeda de cotação description: type: string description: Descrição da cotação dateQuote: type: string description: Data da cotação format: date-time previsionQuote: type: number description: Valor de previsão da cotação format: double quote: type: number description: Valor da Cotação format: double descriptionUnMeasure: type: string description: Descricao da Unidade de Medida singleRecordKey: type: string description: Codigo Unico do Registro de cotação initialsCoin: type: string description: Sigla da Moeda de cotação physicalTransactionReceived: type: object required: – singleRecordKey – cpfCnpjproducer – harvest – culture – product – quantityDelivered – quantityReturned – fixedQuantity – openQuantity – quantityContracts – blockedQuantity properties: singleRecordKey: type: string description: Chave unica do registro de movimentação física cpfCnpjproducer: type: string description: Cpf/Cnpj do Produtor vinculado a movimentação física harvest: type: string description: Safra referente movimentação física culture: type: string description: Cultura referente movimentação física product: type: string description: Produto referente movimentação física quantityDelivered: type: number description: Quantidade entregue referente movimentação física format: double quantityReturned: type: number description: Quantidade devolvida referente movimentação física format: double fixedQuantity: type: number description: Quantidade fixada referente movimentação física format: double openQuantity: type: number description: Quantidade em aberto referente movimentação física format: double quantityContracts: type: number description: Quantidade de contratos referente movimentação física format: double blockedQuantity: type: number description: Quantidade bloqueada referente movimentação física format: double producersReceived: type: object required: – code – cnpjCpf – name – email – situation – producerCustomer – producerSupplier properties: id: type: string description: Id do produtor code: type: integer description: Código id do produtor cnpjCpf: type: string description: CnpjCpf do Produtor name: type: string description: Nome do produtor email: type: string description: Email do produtor situation: #/definitions/situacaoProdutor producerCustomer: type: boolean description: Produtor é cliente producerSupplier: type: boolean description: Produtor é fornecedor externalNotification: type: object required: – producerCpfCnpj – externalNotificationPairs – templateTypeCode properties: producerCpfCnpj: type: string description: User Producer Id externalNotificationPairs: type: array items: #/definitions/externalNotificationPair description: Extenal pairs templateTypeCode: type: string description: TemplateType code externalNotificationPair: type: object required: – metaTagCode – value properties: metaTagCode: type: string description: MetaTag code value: type: string description: value protocols: type: object required: – protocol properties: protocol: type: string description: Protocolo returnProtocols: type: object required: – protocol – statusProtocol – returnProcessing properties: protocol: type: string description: Protocolo statusProtocol: #/definitions/statusRegistrosProcessados returnProcessing: type: array items: #/definitions/jsonReturnAPIBillsFinancialMaster description: Retorno jsonReturnAPIBillsFinancialMaster: type: object required: – financialTittleInError – status properties: cpfCnpj: type: string description: Cpf/ Cnpj Produtor financialTittleInError: #/definitions/jsonReturnAPIBillsFinancial status: #/definitions/statusRegistrosProcessados singleRecordKey: type: string description: Codigo Unico Registro jsonReturnAPIBillsFinancial: type: object required: – singleKeyRecord – messageError – operationTypeCrud properties: singleKeyRecord: type: string description: Chave Unica Registro messageError: type: string description: Mensagem Erro operationTypeCrud: #/definitions/ENumTipoOperacaoCrud genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE