agro (Agronegócio)

2.0info: 3.17.0 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/agroxsecurityDefinitions: 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: /deleteCurrencies: post: description: Recebe a lista de moedas que deve ser marcada como excluida ### Resources - res://senior.com.br/agro/agrox/actions/deleteCurrencies x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – currenciesDeleted properties: currenciesDeleted: type: array items: #/definitions/currencyDeleted description: Lista das singleRecordKeys das moedas que devem ser marcados como excluidas responses: 200: description: Ok schema: type: object required: – protocol properties: protocol: type: string description: Protocolo de processamento 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 get: 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 /createOrUpdateWeighings: post: description: Recebe a lista de pesagens integradas e devolve o protocolo de processamento desses registros ### Resources - res://senior.com.br/agro/agrox/actions/createOrUpdateWeighings x-senior-event: false deprecated: true tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – weighings properties: weighings: type: array items: #/definitions/weighingReceived description: Lista de pesagens recebidas responses: 200: description: Ok schema: type: object required: – protocol properties: protocol: type: string description: Protocolo default: description: Error response schema: #/definitions/genericError /deleteWeighings: post: description: Recebe a lista de classificações que deve ser excluidas ### Resources - res://senior.com.br/agro/agrox/actions/deleteWeighings x-senior-event: false deprecated: true tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – weighings properties: weighings: type: array items: #/definitions/weighingDeleted description: Lista das singleRecordKeys das classificações que devem ser excluídas responses: 200: description: Ok schema: type: object required: – protocol properties: protocol: type: string description: Protocolo de processamento default: description: Error response schema: #/definitions/genericError /createOrUpdateContracts: post: description: Recebe a lista de contratos integrados e devolve o protocolo de processamento desses registros ### Resources - res://senior.com.br/agro/agrox/actions/createOrUpdateContracts x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – contracts properties: contracts: type: array items: #/definitions/contractReceived description: Lista de contratos recebidos responses: 200: description: Ok schema: type: object required: – protocol properties: protocol: type: string description: Protocolo default: description: Error response schema: #/definitions/genericError /createMeasurementUnits: post: description: Registra as Unidades de Medidas ### Resources - res://senior.com.br/agro/agrox/entities/measurementUnit x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – measurementUnits properties: measurementUnits: type: array items: #/definitions/measurementUnitReceived description: Lista das unidades de medidas 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 /listUsersProducersCpfCnpjByStatus: post: description: Recebe um status e retorna a lista de CPF/CNPJ dos produtores que possuem esse status ### Resources - res://senior.com.br/agro/agrox/queries/listUsersProducersCpfCnpjByStatus x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – status properties: status: #/definitions/statusUsuarioProdutor lastSyncDateTime: type: string description: Data hora da ultima requisição realizada nessa API responses: 200: description: Ok schema: type: object required: – syncDateTime – usersProducers properties: syncDateTime: type: string description: Data e Hora Sincronização usersProducers: type: string description: Lista de CPF/CNPJ dos usuários que possuem determinado status default: description: Error response schema: #/definitions/genericError get: description: Recebe um status e retorna a lista de CPF/CNPJ dos produtores que possuem esse status ### Resources - res://senior.com.br/agro/agrox/queries/listUsersProducersCpfCnpjByStatus x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – status properties: status: #/definitions/statusUsuarioProdutor lastSyncDateTime: type: string description: Data hora da ultima requisição realizada nessa API responses: 200: description: Ok schema: type: object required: – syncDateTime – usersProducers properties: syncDateTime: type: string description: Data e Hora Sincronização usersProducers: type: string description: Lista de CPF/CNPJ dos usuários que possuem determinado status default: description: Error response schema: #/definitions/genericError /createOrUpdateCurrencies: post: description: Recebe a lista de moedas integradas e devolve o protocolo de processamento desses registros ### Resources - res://senior.com.br/agro/agrox/actions/createOrUpdateCurrencies x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – currencies properties: currencies: type: array items: #/definitions/currencyReceived description: Lista de moedas recebidas responses: 200: description: Ok schema: type: object required: – protocol properties: protocol: type: string description: Protocolo 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/genericError /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 /createOrUpdateClassifications: post: description: Recebe a lista de classificações integradas e devolve o protocolo de processamento desses registros ### Resources - res://senior.com.br/agro/agrox/actions/createOrUpdateClassifications x-senior-event: false deprecated: true tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – classifications properties: classifications: type: array items: #/definitions/classificationReceived description: Lista de classificações recebidas responses: 200: description: Ok schema: type: object required: – protocol properties: protocol: type: string description: Protocolo default: description: Error response schema: #/definitions/genericError /dailyScheduledJob: post: description: Event who execute daily schedule jobs ### Resources - res://senior.com.br/agro/agrox/actions/dailyScheduledJob x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: deleteLogs: type: boolean description: delete logs createDefaultTemplateTypes: type: boolean description: create default template types createDefaultCategoryMessage: type: boolean description: create default category message responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /deleteClassifications: post: description: Recebe a lista de classificações que deve ser excluidas ### Resources - res://senior.com.br/agro/agrox/actions/deleteClassifications x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – classifications properties: classifications: type: array items: #/definitions/classificationDeleted description: Lista das singleRecordKeys das classificações que devem ser excluídas responses: 200: description: Ok schema: type: object required: – protocol properties: protocol: type: string description: Protocolo de processamento 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 /deleteContracts: post: description: Recebe a lista de contratos que deve ser marcada como excluida ### Resources - res://senior.com.br/agro/agrox/actions/deleteContracts x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – contractsDeleted properties: contractsDeleted: type: array items: #/definitions/contractDeleted description: Lista das singleRecordKeys dos contratos que devem ser marcados como excluidos responses: 200: description: Ok schema: type: object required: – protocol properties: protocol: type: string description: Protocolo de processamento 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 /getProducerByCpfCnpj: post: description: Recupera um produtor pelo CPF/CNPJ ### Resources - res://senior.com.br/agro/agrox/queries/getProducerByCpfCnpj x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cpfCnpj properties: cpfCnpj: type: string description: CPF/CNPJ do produtor responses: 200: description: Ok schema: type: object required: – producer properties: producer: #/definitions/produtor default: description: Error response schema: #/definitions/genericError get: description: Recupera um produtor pelo CPF/CNPJ ### Resources - res://senior.com.br/agro/agrox/queries/getProducerByCpfCnpj x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – cpfCnpj properties: cpfCnpj: type: string description: CPF/CNPJ do produtor responses: 200: description: Ok schema: type: object required: – producer properties: producer: #/definitions/produtor default: description: Error response schema: #/definitions/genericErrordefinitions: statusUsuarioProdutor: type: string enum: – ATIVO – INATIVO situationCurrency: type: string enum: – INACTIVE – ACTIVE ENumTipoOperacaoCrud: type: string enum: – CREATE – UPDATE – DELETE ENumTabelaSync: type: string enum: – CP – CR – COTAS situacaoProdutor: type: string enum: – INATIVO – ATIVO notificationAction: type: string enum: – NO_ACTION – GO_TO_OFFER – GO_TO_CONTRACT – GO_TO_FINANCIAL – GO_TO_PHYSICAL – GO_TO_QUOTAS – GO_TO_CONTRACTS – GO_TO_OFFERS – GO_TO_MESSAGE – GO_TO_MESSAGES – GO_TO_SIGNATURE – GO_TO_PACKING_LIST – GO_TO_NEGOTIATION statusRegistrosProcessados: type: string enum: – SUCESSO – ERRO – PENDENTE weighingDeleted: type: object required: – singleRecordKey properties: singleRecordKey: type: string description: SingleRecordKey weighingReceived: type: object required: – singleRecordKey properties: singleRecordKey: type: string description: Chave única de registro classifications: type: array items: #/definitions/classificationReceived description: Classificações da pesagem company: type: string description: Empresa subsidiary: type: string description: Filial inputDate: type: string description: Data de entrada format: date inputSequence: type: integer description: Sequencia de entrada inputResponsibleUser: type: string description: Usuario responsável pela entrada inputTime: type: string description: Hora de entrada licensePlate: type: string description: Placa do veículo supplier: type: string description: Fornecedor driver: type: string description: Motorista product: type: string description: Produto family: type: string description: Familia harvest: type: string description: Safra cityOfOrigin: type: string description: Cidade de origem derivation: type: string description: Derivação deposit: type: string description: Depósito variety: type: string description: Variedade inputWeight: type: number description: Peso Entrada format: double outputWeight: type: number description: Peso saída format: double capturedWeight: type: boolean description: Peso Capturado S/N classifierUser: type: string description: Usuario Classificador outputUser: type: string description: Usuário Saída outputDate: type: string description: Data de saída format: date outputTime: type: string description: Hora saída ticketNumber: type: integer description: Numero Ticket classificationReceived: type: object required: – singleRecordKey – singleRecordKeyWeighing properties: singleRecordKey: type: string description: Chave única de registro singleRecordKeyWeighing: type: string description: Single record key da pesagem company: type: string description: Empresa subsidiary: type: string description: Filial inputDate: type: string description: Data de entrada format: date inputSequence: type: integer description: Sequencia de entrada itemOfClassification: type: string description: Item de classificação calculatedPercentage: type: number description: Percentual apurado format: double discountPercentage: type: number description: Percentual de desconto format: double discountAmount: type: number description: Quantidade de desconto format: double recordGenerationUser: type: string description: Usuario geração do registro generationDate: type: string description: Data da geração format: date generationTime: type: string description: Hora da geração updateUser: type: string description: Usuario de atualização updateDate: type: string description: Data da atualização format: date updateTime: type: string description: Hora da atualização discountBaseQuantity: type: number description: Quantidade base de desconto format: double sampleWeight: type: number description: Peso de amostra format: double classificationDeleted: type: object required: – singleRecordKey properties: singleRecordKey: type: string description: SingleRecordKey currencyDeleted: type: object required: – singleRecordKey properties: singleRecordKey: type: string description: SingleRecordKey currencyReceived: type: object required: – singleRecordKey properties: singleRecordKey: type: string description: SingleRecordKey code: type: string description: Código description: type: string description: Descrição initials: type: string description: Iniciais situation: #/definitions/situationCurrency contractDeleted: type: object required: – singleRecordKey properties: singleRecordKey: type: string description: SingleRecordKey contractReceived: type: object required: – singleRecordKey – cpfCnpj – contractorName – contractNumber – emissionDate – contractItems properties: singleRecordKey: type: string description: Chave única de integração contractSituation: type: string description: Situação do contrato – ATIVO/INATIVO cpfCnpj: type: string description: CPF – CNPJ do produtor rural contractorName: type: string description: Nome do contratante contractNumber: type: integer description: Número do contrato object: type: string description: Objeto do contrato emissionDate: type: string description: Data da emissão format: date entryDate: type: string description: Data de entrada format: date effectiveStartDate: type: string description: Data inicial de vigência format: date effectiveEndDate: type: string description: Data final de vigência format: date dueDate: type: string description: Data de vencimento dos títulos format: date harvestCode: type: string description: Código da safra harvestDescription: type: string description: Descrição da Safra contractItems: type: array items: #/definitions/contractItemReceived description: Lista de itens do contrato contractItemReceived: type: object required: – singleRecordKey – currencySingleRecordKey – contractSingleRecordKey – productCode – productDescription – unitPrice – contractedQuantity – deliveredQuantity – openQuantity – canceledQuantity – totalQuantity properties: singleRecordKey: type: string description: Chave única de integração currencySingleRecordKey: type: string description: Single record key da Moeda contractSingleRecordKey: type: string description: Single record key do contrato productCode: type: string description: Código do produtor productDescription: type: string description: Descrição do produto derivationCode: type: string description: Código da derivação derivationDescription: type: string description: Descrição da derivação unitPrice: type: string description: Preço unitário contractedQuantity: type: number description: Quantidade contratada format: double deliveredQuantity: type: number description: Quantidade entregue format: double openQuantity: type: number description: Quantidade em aberto format: double canceledQuantity: type: number description: Quantidade cancelada format: double totalQuantity: type: number description: Quantidade total format: double 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 netValue: type: string description: Valor líquido do titulo valueInterest: type: string description: Valor dos Juros valueFine: type: string description: Valor da Multa valueCharges: type: string description: Valor dos Encargos valueAdditions: type: string description: Valor dos Acréscimos valueCorrection: type: string description: Valor da Correção generalDiscounts: type: string description: Descontos Gerais otherDiscounts: type: string description: Outros Descontos 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, somente em caso de comodite 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 harvestPeriod: type: integer description: Vigência da 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 measurementUnit: type: string description: Unidade de Medida measurementUnitReceived: type: object required: – singleRecordKey – description – acronym properties: singleRecordKey: type: string description: Chave unica do registro de unidade de medida description: type: string description: Descrição da unidade de medida acronym: type: string description: Sigla da unidade de medida 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 phone: type: string description: Telefone 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 externalNotificationAction: #/definitions/externalNotificationAction externalNotificationPair: type: object required: – metaTagCode – value properties: metaTagCode: type: string description: MetaTag code value: type: string description: value externalNotificationAction: type: object required: – notificationAction – referenceId properties: notificationAction: #/definitions/notificationAction referenceId: type: string description: Action reference ID 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 produtor: type: object required: – nome – cnpjCpf properties: id: type: string description: format: uuid codigo: type: integer description: Código nome: type: string description: Nome email: type: string description: Site telefone: type: string description: telefone situacao: #/definitions/situacaoProdutor produtorCliente: type: boolean description: Produtor é Cliente produtorFornecedor: type: boolean description: Produtor é Fornecedor cnpjCpf: type: string description: CNPJ/CPF observacao: type: string description: Observações createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time 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