Controladoria (compliance_fiscal)

Controladoria (compliance_fiscal)

149 views 14/05/2021 23/11/2021 integrador 0

2.0info: 1.0.1 Controladoria description: ERP Senior X – Serviço de Compliance Fiscal x-senior-domain: ERP Senior X – Controladoria x-senior-domain-path: erpx x-senior-service-path: compliance_fiscal contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /erpx/compliance_fiscal/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonpaths: /bulkDeleteArInvoice: post: description: Exclui notas de saída em lote x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: #/definitions/arInvoiceFilterData responses: 200: description: Ok schema: type: object required: – ticketId properties: ticketId: type: string description: Ticket da exclusão assíncrona de notas de entrada 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 /deleteMonthlyInformationBatch: post: description: Excluir em lote os lançamentos de informações mensais, através de um filtro x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: id: type: array items: type: string description: Identificador único do lançamento competenceInitial: type: string description: Data competência inicial competenceFinal: type: string description: Data competência final company: type: array items: #/definitions/recCompany description: Dados da empresa branch: type: array items: #/definitions/recBranch description: Dados da filial responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /createMonthlyInformation: post: description: Insere um novo lançamento manual de informações mensais x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – company – branch – pisValue properties: company: #/definitions/recCompany branch: #/definitions/recBranch competence: type: string description: Data competência numberStaff: type: integer description: Número de funcionários payrollPeriod: type: string description: Valor total folha de pagamento discount: type: string description: Valor que compõe a base de cálculo pisPercentage: type: string description: Percentual PIS pisValue: type: string description: Valor PIS responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador único do lançamento default: description: Error response schema: #/definitions/genericError /listArInvoice: post: description: Consulta as notas de saída x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: #/definitions/arInvoiceFilterData pageRequest: #/definitions/recPageRequest responses: 200: description: Ok schema: type: object properties: pagedResults: #/definitions/arInvoicePagedResults 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 /updateMonthlyInformation: post: description: Atualizar um lançamento já realizado de um lançamento manual de informações mensais x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – id – company – branch – pisValue properties: id: type: string description: Identificador único do lançamento company: #/definitions/recCompany branch: #/definitions/recBranch competence: type: string description: Data competência numberStaff: type: integer description: Número de funcionários payrollPeriod: type: string description: Valor total folha de pagamento discount: type: string description: Valor que compõe a base de cálculo pisPercentage: type: string description: Percentual PIS pisValue: type: string description: Valor PIS responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador único do lançamento default: description: Error response schema: #/definitions/genericError /deleteArInvoice: post: description: Exclui uma nota de saída pelo id x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – arInvoiceId properties: arInvoiceId: type: string description: Id da nota de saída responses: 200: description: Ok schema: type: object required: – success – message properties: success: type: boolean description: Indicador de sucesso ou falha da operação message: type: string description: Mensagem de sucesso ou falha da operação default: description: Error response schema: #/definitions/genericError /createArInvoice: post: description: Incluir nota fiscal de saída para integração x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – arInvoice properties: arInvoice: type: array items: #/definitions/arInvoiceData description: Cabeçalho da nota fiscal de saída responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do lançamento 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 /listMonthlyInformation: post: description: Listar os lançamentos manuais realizados x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: id: type: array items: type: string description: Identificador único do lançamento competenceInitial: type: string description: Data competência inicial competenceFinal: type: string description: Data competência final company: type: array items: #/definitions/recCompany description: Dados da empresa branch: type: array items: #/definitions/recBranch description: Dados da filial pageRequest: #/definitions/recPageRequest responses: 200: description: Ok schema: type: object properties: pagedResults: #/definitions/recPagedResults default: description: Error response schema: #/definitions/genericError /createAccountingLot: post: description: Criar um lote contábil x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – company – branch – dateOfLot properties: company: #/definitions/companyIdentifier branch: #/definitions/branchIdentifier dateOfLot: type: string description: Data do lote contábil responses: 200: description: Ok schema: type: object required: – accountingLot properties: accountingLot: #/definitions/accountingLotIdentifier 403: description: Permissão negada 401: description: Usuário ou senha inválido 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente default: description: Error response schema: #/definitions/genericErrordefinitions: enumArInvoiceSituation: type: string enum: – BOOK_KEEPING_IN_PROGRESS – BOOK_KEEPING_FINISHED – CANCELED – ACCOUNTED enumArInvoiceType: type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V9 – V10 – V11 enumArInvoiceOrigin: type: string enum: – MANUAL – ERP_SENIOR_X – THIRD_PARTY_SOFTWARE enumArInvoiceAccountingFactOrigin: type: string enum: – CONTROLLERSHIP_AR_INVOICE – ERP_SENIOR_X_AR_INVOICE – THIRD_PARTY_AR_INVOICE enumItemType: type: string enum: – SERVICE – PRODUCT enumTaxType: type: string enum: – IPI – PRESUMED_IPI – RETURNED_IPI – CREDITED_IPI – ICMS – ICMS_SIMPLES – FUTURE_ICMS – DEFERRED_ICMS – EXCEMPTED_ICMS – ICMS_ST – DESTINATION_ICMS_STATE – EXCEMPT_OTHERS_ICMS – CREDITED_ICMS – EFFECTIVE_ICMS – PREVIOUSLY_RETAINED_ICMS_ST – FUTURE_ICMS_ST – SOLIDARITY_ICMS_ST – IMPORT_ICMS – DESTINATION_ICMS – FCP – FCP_ST – FCP_UF_DESTINO – PREVIOUSLY_RETAINED_FCP_ST – ISS – COFINS – RETAINED_COFINS – IMPORT_RECOVERED_COFINS – RECOVERED_COFINS – RETURNED_COFINS – PIS – RETAINED_PIS – IMPORT_RECOVERED_PIS – RECOVERED_PIS – RETURNED_PI – CSLL – RETAINED_ISS – IRRF – INSS – EMPLOYER_CONTRIBUITION – IMPORT_TAX – DIFAL – RETURNED_DIFAL – TECHNOLOGY_CIDE enumIcmsExceptionReason: type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V16 – V90 enumCommodityOrigin: type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 enumTaxApplication: type: string enum: – VA – VS – VN enumDeferralType: type: string enum: – BASIS – VALUE enumRetentionControlRegime: type: string enum: – CASH – COMPETENCE enumReferenceType: type: string enum: – RETURN – TRIANGULATION – OTHERS enumReferencedInvoiceOperation: type: string enum: – INPUT – OUTPUT enumReferencedInvoiceEmissionType: type: string enum: – OWN_ISSUE – THIRD_PARTY_ISSUE enumElectronicDocumentSituation: type: string enum: – V01 – V02 – V03 – V04 – V05 – V06 – V07 – V08 – V09 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 – V19 enumFreightType: type: string enum: – C – F – T – X enumTransportMode: type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V9 enumDocumentTaxType: type: string enum: – V00 – V01 – V02 – V03 – V04 – V99 enumCardType: type: string enum: – D – C enumTypeOrder: type: string enum: – ASC – DESC arInvoiceData: type: object required: – company – branch – series – documentModel – receiver – layoffDate – outputDate – situation – invoiceType – origin – accountingFactOrigin properties: id: type: string description: Id da nota de saída company: #/definitions/recCompany branch: #/definitions/recBranch invoiceNumber: type: integer description: Número da nota fiscal series: #/definitions/seriesData documentModel: #/definitions/documentModelData receiver: #/definitions/personData deliveryAddress: type: array items: #/definitions/addressData description: Endereço de entrega serviceProvisionDate: type: string description: Data de execução do serviço format: date layoffDate: type: string description: Data de emissão format: date outputDate: type: string description: Data de saída format: date admissionManausFreeTradeZoneDate: type: string description: Data da ingresso zona franca de manaus format: date eletronicKey: type: string description: Chave eletrônica icmsCalcState: #/definitions/stateData issTaxCity: #/definitions/cityData accountingBatchNumber: type: integer description: Número do lote contábil situation: #/definitions/enumArInvoiceSituation invoiceType: #/definitions/enumArInvoiceType origin: #/definitions/enumArInvoiceOrigin accountingFactOrigin: #/definitions/enumArInvoiceAccountingFactOrigin accountingFact: type: string description: Fato contábil items: type: array items: #/definitions/arInvoiceItemsData description: Itens da nota fiscal de saída general: #/definitions/arInvoiceGeneralData carrier: #/definitions/arInvoiceCarrierData financial: type: array items: #/definitions/arInvoiceFinancialData description: Infomações financeiras da nota fiscal messages: type: array items: #/definitions/arInvoiceMessageData description: Mensagens da nota fiscal de saída referencedDocumentInvoice: type: array items: #/definitions/arInvoiceReferencedDocumentData description: Documentos referenciados recCompany: type: object properties: companyId: type: string description: Identificador da empresa companyCode: type: integer description: Código empresa tradeName: type: string description: Nome fantasia recBranch: type: object properties: branchId: type: string description: Identificador da filial branchCode: type: integer description: Código filial documentNumber: type: string description: Número do cnpj ou cpf nifNumber: type: string description: Número do identificador fiscal (nif) tradeName: type: string description: Nome fantasia seriesData: type: object properties: id: type: string description: Id da série fiscal code: type: string description: Código da série fiscal documentModelData: type: object properties: id: type: string description: Id do modelo de documento code: type: string description: Código modelo documento personData: type: object properties: id: type: string description: Identificador code: type: integer description: Código documentNumber: type: string description: Número do CNPJ ou CPF addressData: type: object properties: id: type: string description: Id do endereço country: #/definitions/countryData state: #/definitions/stateData city: #/definitions/cityData countryData: type: object properties: id: type: string description: Identificador do país code: type: string description: Código stateData: type: object properties: id: type: string description: Identificador do estado code: type: string description: Sigla cityData: type: object properties: id: type: string description: Id da entidade code: type: integer description: Código cidade cityName: type: string description: Nome cidade arInvoiceItemsData: type: object required: – sequence – transaction – cfop – printableDescription – quantity properties: itemId: type: string description: Identificador do item da nota fiscal sequence: type: integer description: Sequência transaction: #/definitions/transactionData cfop: type: string description: CFOP item: #/definitions/itemData asset: #/definitions/assetData printableDescription: type: string description: Descrição do item para impressão complement: type: string description: Complemento ncm: #/definitions/ncmData cestCode: type: string description: CEST quantity: type: number description: Quantidade format: double measurementUnit: #/definitions/measurementUnitData unitPrice: type: string description: Preço unitário commodityValue: type: string description: Valor da mercadoria discountAmount: type: string description: Valor de desconto insuranceValue: type: string description: Valor de seguro costFreight: type: string description: Valor de frete additionalExpensesValue: type: string description: Valor de despesas acessórias bookValue: type: string description: Valor contábil bookAccount: #/definitions/bookAccountData costCenter: #/definitions/costCenterData taxes: type: array items: #/definitions/arInvoiceItemsTaxData description: Impostos do item referencedInvoice: #/definitions/arInvoiceReferencedDocumentData itemMessages: type: array items: #/definitions/arInvoiceMessageData description: Mensagens dos itens da nota fiscal de saída taxArrangements: type: array items: #/definitions/arInvoiceTaxArrangementsData description: Dispositivo fiscal dos itens batchSeries: type: array items: #/definitions/arInvoiceItemsBatchSeriesData description: Lote e série do item da nota transactionData: type: object properties: id: type: string description: Identificador da transação code: type: string description: Transação itemData: type: object properties: id: type: string description: Id do item code: type: string description: Codigo do item itemType: #/definitions/enumItemType assetData: type: object properties: id: type: string description: Identificador do bem patrimonial code: type: string description: Código do bem ncmData: type: object properties: id: type: string description: Id da entidade code: type: string description: Nomenclatura comum do Mercosul (NCM) measurementUnitData: type: object properties: id: type: string description: Identificador unidade de medida code: type: string description: Código da unidade de medida bookAccountData: type: object properties: id: type: string description: Id da entidade code: type: integer description: Código da conta contábil costCenterData: type: object properties: id: type: string description: Id da entidade code: type: string description: Código do centro de custos arInvoiceItemsTaxData: type: object properties: taxType: #/definitions/enumTaxType baseValue: type: string description: Valor Base taxAliquot: type: number description: Alíquota do imposto format: double taxAmount: type: string description: Valor Imposto otherValues: type: string description: Valor Outras exemptValues: type: string description: Valor Isentas baseReductionPercentage: type: number description: Percentual de redução da base do imposto format: double deductionAmount: type: string description: Valor de dedução mvaPercentage: type: number description: Percentual da margem de valor agregado do ICMS ST format: double icmsTaxSituation: #/definitions/icmsTaxSituationData ipiFramework: #/definitions/ipiFrameworkData icmsExceptionReason: #/definitions/enumIcmsExceptionReason commodityOrigem: #/definitions/enumCommodityOrigin incomeNaturePisCofins: #/definitions/incomeNaturePisCofinsData taxationCode: type: string description: Código da tributação note: type: string description: Observação taxApplication: #/definitions/enumTaxApplication manualTaxApplication: type: boolean description: Aplicação manual de imposto paymentSlipPerDocument: type: boolean description: Guia por Documento interestateIcmsRate: type: number description: Alíquota de ICMS interestadual da UF de destino format: double amountCollected: type: string description: Valor recolhido pelo substituto supEndConsumer: type: number description: Suportado consumidor final format: double icmsStRetainedValue: type: string description: Valor Icms St retido deferralType: #/definitions/enumDeferralType retentionControlRegime: #/definitions/enumRetentionControlRegime icmsTaxSituationData: type: object properties: id: type: string description: Id da situação tributária code: type: string description: Código da situação tributária ipiFrameworkData: type: object properties: id: type: string description: Id do enquadramento code: type: integer description: Código do enquadramento incomeNaturePisCofinsData: type: object properties: id: type: string description: Id da natureza de receita code: type: integer description: Código da natureza arInvoiceReferencedDocumentData: type: object required: – referenceType – documentNumber – referencedInvoiceOperation – legalSeries – issueDateReferencedInvoice properties: referencedDocumentId: type: string description: Id da nota de origem referencedItemId: type: string description: Id do item de origem referenceType: #/definitions/enumReferenceType branch: #/definitions/recBranch documentNumber: type: integer description: Número do documento person: #/definitions/personData series: #/definitions/seriesData itemSequence: type: integer description: Sequência do item da nota fiscal referencedItemSequence: type: integer description: Sequência do item da nota fiscal referenciado referencedInvoiceOperation: #/definitions/enumReferencedInvoiceOperation referencedInvoiceEmissionType: #/definitions/enumReferencedInvoiceEmissionType referencedInvoiceKey: type: string description: Chave da nota fiscal eletrônica referenciada referencedDocumentModel: #/definitions/documentModelData legalSeries: type: string description: Código da série legal legalSubseries: type: string description: Código da subsérie legal issueDateReferencedInvoice: type: string description: Data de emissão da nota fiscal referenciada format: date measurementUnity: #/definitions/measurementUnitData commodityQuantity: type: number description: Quantidade de mercadorias format: double volumeQuantity: type: integer description: Quantidade de volumes grossWeight: type: number description: Peso bruto format: double netWeight: type: number description: Peso Líquido format: double commodityValue: type: string description: Valor mercadoria totalInvoiceAmount: type: string description: Valor total da nota fiscal arInvoiceMessageData: type: object properties: id: type: string description: Id da mensagem code: type: integer description: Código da mensagem message: type: string description: Mensagem arInvoiceTaxArrangementsData: type: object properties: id: type: string description: Id do dispositivo fiscal code: type: integer description: Código do dispositivo fiscal arInvoiceItemsBatchSeriesData: type: object properties: expirationDate: type: string description: Data de validade format: date manufacturingDate: type: string description: Data de fabricação format: date batchNumber: type: string description: Número do lote serialNumber: type: string description: Número da série quantity: type: number description: Quantidade de movimento format: double arInvoiceGeneralData: type: object properties: thirdPartyValue: type: string description: Valor em nome de terceiros thirdPartyIssue: type: boolean description: Emissão de terceiros extemporaneousSpedDate: type: string description: Data extemporâneo SPED format: date electronicDocumentSituation: #/definitions/enumElectronicDocumentSituation rpsNumber: type: integer description: Número RPS para nota de serviço arInvoiceCarrierData: type: object properties: freightType: #/definitions/enumFreightType transportMode: #/definitions/enumTransportMode carrier: #/definitions/personData vehiclePlate: type: string description: Placa do veículo vehicleState: #/definitions/stateData grossWeight: type: number description: Peso bruto format: double netWeight: type: number description: Peso Líquido format: double sender: #/definitions/personData senderState: #/definitions/stateData senderStateRegister: type: string description: inscrição estadual do remetente senderAddress: #/definitions/addressData receiver: #/definitions/personData receiverAddressSequence: #/definitions/addressData consignee: #/definitions/personData arInvoiceFinancialData: type: object properties: paymentType: #/definitions/paymentTypeData paymentTerms: #/definitions/paymentTermsData documentTaxType: #/definitions/enumDocumentTaxType dueDate: type: string description: Data de vencimento do título format: date titleNumber: type: string description: Número do título value: type: string description: Valor da parcela cardType: #/definitions/enumCardType complementaryDescription: type: string description: Descrição complementar do título paymentTypeData: type: object properties: id: type: string description: Id forma de pagamento code: type: integer description: Código da forma de pagamento paymentTermsData: type: object properties: id: type: string description: Id condição de pagamento code: type: string description: Código condição de pagamento arInvoiceFilterData: type: object properties: company: type: array items: #/definitions/recCompany description: Dados da empresa branch: type: array items: #/definitions/recBranch description: Dados da filial documentNumber: type: string description: Número CPF / CNPJ nifNumber: type: string description: Número do identificador fiscal receiver: type: array items: #/definitions/personData description: Dados destinatário series: type: array items: #/definitions/seriesData description: Série transaction: type: array items: #/definitions/transactionData description: Dados da transação item: type: array items: #/definitions/itemData description: Dados do item asset: type: array items: #/definitions/assetData description: Dados bem patrimonial initialLayoffDate: type: string description: Data de emissão inicial format: date finalLayoffDate: type: string description: Data de emissão final format: date invoiceNumber: type: integer description: Número da nota de saída origin: #/definitions/enumArInvoiceOrigin situation: #/definitions/enumArInvoiceSituation electronicKey: type: string description: Chave da nota arInvoicePagedResults: type: object required: – totalPages – totalElements properties: totalPages: type: integer description: Total de páginas totalElements: type: integer description: Total de lançamentos encontrados contents: type: array items: #/definitions/arInvoiceData description: Lista com os registros encontrados recPageRequest: type: object required: – offset – size properties: offset: type: integer description: Página atual size: type: integer description: Total de páginas orderBy: type: array items: #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados recFieldsOrderBy: type: object required: – field – order properties: field: type: string description: Nome do campo a ser ordenado order: #/definitions/enumTypeOrder recPagedResults: type: object required: – totalPages – totalElements properties: totalPages: type: integer description: Total de páginas totalElements: type: integer description: Total de lançamentos encontrados contents: type: array items: #/definitions/recMonthlyInformation description: Lista com os registros encontrados recMonthlyInformation: type: object required: – id – company – branch – competence – pisValue properties: id: type: string description: Identificador company: #/definitions/recCompany branch: #/definitions/recBranch competence: type: string description: Data competência numberStaff: type: integer description: Número de funcionários payrollPeriod: type: string description: Valor total folha de pagamento discount: type: string description: Valor que compõe a base de cálculo pisPercentage: type: string description: Percentual PIS pisValue: type: string description: Valor PIS companyIdentifier: type: object properties: id: type: string description: Identificador único da empresa code: type: integer description: Código da empresa branchIdentifier: type: object properties: id: type: string description: Identificador único da filial code: type: integer description: Codigo da filial documentNumber: type: string description: Número do CNPJ ou CPF nifNumber: type: string description: Número de identificação fiscal accountingLotIdentifier: type: object required: – code properties: company: #/definitions/companyIdentifier id: type: string description: Identificador do lote code: type: string description: Código do lote 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

Este artigo foi útil para você?

Leave A Comment