Controladoria (compliance_fiscal)

2.0info: 2.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: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erpxsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /compliance_fiscal/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status geral do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/getProductMask: post: description: Busca máscaras de codificação de produto conforme família de produtos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyCode – familyId properties: companyCode: type: integer format: int64 description: Código da empresa familyId: type: string description: Id da família de produtos responses: 200: description: Ok schema: type: object properties: masks: type: array items: type: object allOf: – #/definitions/recProductMask description: Relação de máscaras de SKU aplicáveis à família 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca máscaras de codificação de produto conforme família de produtos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: companyCode description: Código da empresa in: query required: true type: integer format: int64 – name: familyId description: Id da família de produtos in: query required: true type: string responses: 200: description: Ok schema: type: object properties: masks: type: array items: type: object allOf: – #/definitions/recProductMask description: Relação de máscaras de SKU aplicáveis à família 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/getProductMask__2: post: description: Busca máscaras de codificação de produto conforme família de produtos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – companyCode – familyId – test properties: companyCode: type: integer format: int64 description: Código da empresa familyId: type: string description: Id da família de produtos test: type: string description: responses: 200: description: Ok schema: type: object properties: masks: type: array items: type: object allOf: – #/definitions/recProductMask description: Relação de máscaras de SKU aplicáveis à família 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca máscaras de codificação de produto conforme família de produtos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: companyCode description: Código da empresa in: query required: true type: integer format: int64 – name: familyId description: Id da família de produtos in: query required: true type: string – name: test description: in: query required: true type: string responses: 200: description: Ok schema: type: object properties: masks: type: array items: type: object allOf: – #/definitions/recProductMask description: Relação de máscaras de SKU aplicáveis à família 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/getArInvoice: post: description: Consulta as notas de saída tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: id: type: string description: Id da nota fiscal responses: 200: description: Ok schema: type: object required: – arInvoice properties: arInvoice: type: object allOf: – #/definitions/arInvoiceData description: Nota fiscal de saída 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Consulta as notas de saída tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Id da nota fiscal in: query type: string responses: 200: description: Ok schema: type: object required: – arInvoice properties: arInvoice: type: object allOf: – #/definitions/arInvoiceData description: Nota fiscal de saída 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/listArInvoice: post: description: Consulta as notas de saída tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/arInvoiceFilterData description: Filtros para consulta de notas de saída pageRequest: type: object allOf: – #/definitions/recPageRequest description: Definição de paginação responses: 200: description: Ok schema: type: object properties: pagedResults: type: object allOf: – #/definitions/invoicePagedResults description: Resultado da pesquisa 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/listApInvoice: post: description: Consultar notas de entrada tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/apInvoiceFilterData description: Filtros para consulta de notas de saída pageRequest: type: object allOf: – #/definitions/recPageRequest description: Definição de paginação responses: 200: description: Ok schema: type: object properties: pagedResults: type: object allOf: – #/definitions/invoicePagedResults description: Resultado da pesquisa 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/getApInvoice: post: description: Consulta as notas de saída tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: id: type: string description: Id da nota fiscal responses: 200: description: Ok schema: type: object required: – apInvoice properties: apInvoice: type: object allOf: – #/definitions/apInvoiceData description: Nota fiscal de entrada 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError get: description: Consulta as notas de saída tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Id da nota fiscal in: query type: string responses: 200: description: Ok schema: type: object required: – apInvoice properties: apInvoice: type: object allOf: – #/definitions/apInvoiceData description: Nota fiscal de entrada 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/listMonthlyInformation: post: description: Listar os lançamentos manuais realizados tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – costCenter properties: id: type: array items: type: string description: Identificador único do lançamento competenceInitial: type: string maxLength: 7 description: Data competência inicial competenceFinal: type: string maxLength: 7 description: Data competência final company: type: array items: type: object allOf: – #/definitions/recCompany description: Dados da empresa branch: type: array items: type: object allOf: – #/definitions/recBranch description: Dados da filial pageRequest: type: object allOf: – #/definitions/recPageRequest description: Definição de paginação costCenter: type: object allOf: – #/definitions/costCenterData description: Dados do centro de custo responses: 200: description: Ok schema: type: object properties: pagedResults: type: object allOf: – #/definitions/recPagedResults description: Resultado da pesquisa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/exportCompany: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/exportProductFamily: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/exportSpendingNature: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/exportStatusReason: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/exportGroupingSalesQuotas: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/exportMeasureUnit: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/exportNcm: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/exportProduct: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/exportCurrency: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/exportCountry: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/createArInvoice: post: description: Incluir nota fiscal de saída para integração tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – arInvoice properties: arInvoice: type: object allOf: – #/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 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/deleteArInvoice: post: description: Exclui uma nota de saída pelo id tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: arInvoiceIds: type: array items: type: string description: Ids das notas 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 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Nota fiscal não encontrada default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/bulkDeleteArInvoice: post: description: Exclui notas de saída em lote tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: object allOf: – #/definitions/arInvoiceFilterData description: Filtros para exclusão das notas de entrada 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 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/createApInvoice: post: description: Incluir nota fiscal de entrada para integração tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – apInvoice properties: apInvoice: type: object allOf: – #/definitions/apInvoiceData description: Dados da nota fiscal de entrada responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador do lançamento 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/deleteApInvoice: post: description: Exclui uma nota de saída pelo id tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: listApInvoiceId: type: array items: 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 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Nota fiscal não encontrada default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/bulkDeleteApInvoice: post: description: Exclui notas de saída em lote tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: filter: type: object allOf: – #/definitions/apInvoiceFilterData description: Filtros para exclusão das notas de entrada responses: 200: description: Ok schema: type: object required: – ticketId properties: ticketId: type: string description: Ticket da exclusão assíncrona de notas de entrada 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/createMonthlyInformation: post: description: Insere um novo lançamento manual de informações mensais tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – company – branch – pisValue properties: company: type: object allOf: – #/definitions/recCompany description: Dados da empresa branch: type: object allOf: – #/definitions/recBranch description: Dados da filial competence: type: string maxLength: 7 description: Data competência numberStaff: type: integer format: int64 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/updateMonthlyInformation: post: description: Atualizar um lançamento já realizado de um lançamento manual de informações mensais tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id – company – branch – pisValue – costCenterData properties: id: type: string description: Identificador único do lançamento company: type: object allOf: – #/definitions/recCompany description: Dados da empresa branch: type: object allOf: – #/definitions/recBranch description: Dados da filial competence: type: string maxLength: 7 description: Data competência numberStaff: type: integer format: int64 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 costCenterData: type: object allOf: – #/definitions/costCenterData description: Dados do centro de custo responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Identificador único do lançamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/deleteMonthlyInformationBatch: post: description: Excluir em lote os lançamentos de informações mensais, através de um filtro tags: – Actions x-senior-visibility: PUBLIC 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 maxLength: 7 description: Data competência inicial competenceFinal: type: string maxLength: 7 description: Data competência final company: type: array items: type: object allOf: – #/definitions/recCompany description: Dados da empresa branch: type: array items: type: object allOf: – #/definitions/recBranch description: Dados da filial responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/createAccountingLot: post: description: Criar um lote contábil tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – company – branch – dateOfLot – type properties: company: type: object allOf: – #/definitions/companyIdentifier description: Identificação da empresa branch: type: object allOf: – #/definitions/branchIdentifier description: Identificação da filial dateOfLot: type: string format: date description: Data do lote contábil type: type: string allOf: – #/definitions/enumLotType description: Tipo do lote responses: 200: description: Ok schema: type: object required: – accountingLot properties: accountingLot: type: object allOf: – #/definitions/accountingLotIdentifier description: Lote contábil gerado 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/createBulkAccountingEntries: post: description: Realizar a geração de lançamentos contábeis relacionados a um lote de forma assíncrona\n ### Resources\n – res://senior.com.br/erpx/compliance_fiscal/actions/createBulkAccountingEntries tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – accountingLotId – accountingEntries properties: accountingLotId: type: string description: Identificação do lote contábil accountingEntries: type: array items: type: object allOf: – #/definitions/accountingEntryData minimum: 1 description: Lista de lançamentos contábeis responses: 200: description: Ok schema: type: object required: – ticket properties: ticket: type: string description: Identificador de controle da operação 401: description: Invalid Credentials 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 403: description: Permissão negada 404: description: Lote contábil não encontrado default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/importCompany: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/importProductFamily: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/importSpendingNature: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/importStatusReason: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/importGroupingSalesQuotas: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/importMeasureUnit: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/importNcm: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/importProduct: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/importCurrency: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/actions/importCountry: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/importCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/exportCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/importProductFamilyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/exportProductFamilyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/importSpendingNatureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/exportSpendingNatureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/importStatusReasonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/exportStatusReasonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/importGroupingSalesQuotasEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/exportGroupingSalesQuotasEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/importMeasureUnitEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/exportMeasureUnitEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/importNcmEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/exportNcmEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/importProductEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/exportProductEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/importCurrencyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/exportCurrencyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/importCountryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/events/exportCountryEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/company: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/company responses: 200: description: The created resource schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/company/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/company/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/company responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/productFamily: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/productFamily responses: 200: description: The created resource schema: #/definitions/productFamily 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/productFamily responses: 200: description: The created resource schema: #/definitions/productFamily 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/productFamily 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/productFamily/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/productFamily responses: 200: description: Ok schema: #/definitions/productFamily 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/productFamily responses: 200: description: Ok schema: #/definitions/productFamily 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/productFamily 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/productFamily/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/productFamily responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/spendingNature: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/spendingNature responses: 200: description: The created resource schema: #/definitions/spendingNature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/spendingNature responses: 200: description: The created resource schema: #/definitions/spendingNature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/spendingNature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/spendingNature/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/spendingNature responses: 200: description: Ok schema: #/definitions/spendingNature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/spendingNature responses: 200: description: Ok schema: #/definitions/spendingNature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/spendingNature 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/spendingNature/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/spendingNature responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/statusReason: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/statusReason responses: 200: description: The created resource schema: #/definitions/statusReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/statusReason responses: 200: description: The created resource schema: #/definitions/statusReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/statusReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/statusReason/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/statusReason responses: 200: description: Ok schema: #/definitions/statusReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/statusReason responses: 200: description: Ok schema: #/definitions/statusReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/statusReason 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/statusReason/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/statusReason responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/groupingSalesQuotas: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/groupingSalesQuotas responses: 200: description: The created resource schema: #/definitions/groupingSalesQuotas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/groupingSalesQuotas responses: 200: description: The created resource schema: #/definitions/groupingSalesQuotas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/groupingSalesQuotas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/groupingSalesQuotas/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/groupingSalesQuotas responses: 200: description: Ok schema: #/definitions/groupingSalesQuotas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/groupingSalesQuotas responses: 200: description: Ok schema: #/definitions/groupingSalesQuotas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/groupingSalesQuotas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/groupingSalesQuotas/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/groupingSalesQuotas responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/measureUnit: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/measureUnit responses: 200: description: The created resource schema: #/definitions/measureUnit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/measureUnit responses: 200: description: The created resource schema: #/definitions/measureUnit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/measureUnit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/measureUnit/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/measureUnit responses: 200: description: Ok schema: #/definitions/measureUnit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/measureUnit responses: 200: description: Ok schema: #/definitions/measureUnit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/measureUnit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/measureUnit/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/measureUnit responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/ncm: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ncm responses: 200: description: The created resource schema: #/definitions/ncm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/ncm responses: 200: description: The created resource schema: #/definitions/ncm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/ncm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/ncm/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/ncm responses: 200: description: Ok schema: #/definitions/ncm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/ncm responses: 200: description: Ok schema: #/definitions/ncm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/ncm 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/ncm/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/ncm responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/product: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/product responses: 200: description: The created resource schema: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/product responses: 200: description: The created resource schema: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/product/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/product responses: 200: description: Ok schema: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/product responses: 200: description: Ok schema: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/product/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/product responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/currency: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/currency responses: 200: description: The created resource schema: #/definitions/currency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/currency responses: 200: description: The created resource schema: #/definitions/currency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/currency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/currency/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/currency responses: 200: description: Ok schema: #/definitions/currency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/currency responses: 200: description: Ok schema: #/definitions/currency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/currency 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/currency/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/currency responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/country: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/country responses: 200: description: The created resource schema: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/country responses: 200: description: The created resource schema: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/country/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/country responses: 200: description: Ok schema: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/country responses: 200: description: Ok schema: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/country 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /compliance_fiscal/entities/country/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/country responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: enumNfSaidaSituacao: description: Situação da nota fiscal de saída type: string enum: – EM_ESCRITURACAO – ESCRITURADA – CANCELADA – CONTABILIZADA enumCreditCalculationBasis: description: Base de cálculo de crédito type: string enum: – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 enumApInvoiceType: description: Tipo da nota fiscal type: string enum: – V1 – V2 – V4 – V8 – V9 – V10 – V12 enumImportDeclarationType: description: Tipo de declaração da importação type: string enum: – V0 – V1 – V2 enumNfSaidaProcesso: description: Estado do processo da nota type: string enum: – PROCESSANDO – ERRO_PROCESSAMENTO – LIBERADO – EM_EXCLUSAO – ERRO_EXCLUSAO_INTEGRACAO – PROCESSANDO_REFERENCIAS enumOrigemNfSaida: description: Origem da nota fiscal de saída type: string enum: – MANUAL – ERP_SENIOR_X – SISTEMA_TERCEIRO enumInvoiceOrigin: description: Origem da nota de saída type: string enum: – MANUAL – ERP_SENIOR_X – THIRD_PARTY_SOFTWARE enumInvoiceAccountingFactOrigin: description: Origem do fato contábil type: string enum: – CONTROLLERSHIP_AR_INVOICE – ERP_SENIOR_X_AR_INVOICE – THIRD_PARTY_SOFTWARE enumReferenceType: description: Tipo de relacionamento entre documento type: string enum: – RETURN – TRIANGULATION – OTHERS – CARRIED_INVOICE enumReferencedInvoiceOperation: description: Operação da nota fiscal referenciada type: string enum: – INPUT – OUTPUT enumInvoiceEmissionType: description: Emissão da nota fiscal referenciada type: string enum: – OWN_ISSUE – THIRD_PARTY_ISSUE enumTypePayment: description: Enumeration da forma de pagamento type: string enum: – V01 – V02 – V03 – V04 – V05 – V10 – V11 – V12 – V13 – V15 – V90 – V99 enumDocumentTaxType: description: Tipo de título fiscal type: string enum: – V00 – V01 – V02 – V03 – V04 – V99 enumCardType: description: Tipo de cartão type: string enum: – D – C enumItemType: description: Tipo do item type: string enum: – SERVICE – PRODUCT enumArInvoiceType: description: Tipo da nota fiscal type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V9 – V10 – V11 enumElectronicDocumentSituation: description: Situação eletrônica do documento type: string enum: – V01 – V02 – V03 – V04 – V05 – V06 – V07 – V08 – V09 – V10 – V11 – V12 – V13 – V14 – V15 – V16 – V17 – V18 – V19 enumFreightType: description: Situação do registro type: string enum: – C – F – T – X enumTransportMode: description: Via do transporte type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V9 enumInvoiceSituation: description: Situação da nota fiscal de saída type: string enum: – BOOK_KEEPING_IN_PROGRESS – BOOK_KEEPING_FINISHED – CANCELED – ACCOUNTED enumBatchSerial: description: Tipo do registro de lote e série type: string enum: – BATCH – SERIAL enumTaxType: description: Tipo de impostos que podem ser realacionados ao item da nota fiscal 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_PIS – CSLL – RETAINED_ISS – IRRF – INSS – EMPLOYER_CONTRIBUITION – IMPORT_TAX – DIFAL – RETURNED_DIFAL – TECHNOLOGY_CIDE – ICMS_RECOVERED_DESTINATION_STATE – FCP_RECOVERED_DESTINATION_STATE enumIcmsExceptionReason: description: Motivos de desoneração, usados no cadastro do imposto type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 – V9 – V10 – V11 – V12 – V16 – V90 enumCommodityOrigin: description: Origem de mercadoria definida no imposto do item type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 enumTaxApplication: description: Aplicação do imposto type: string enum: – VA – VS – VN enumDeferralType: description: Indicativo de como será o tipo de diferimento type: string enum: – BASIS – VALUE enumRetentionControlRegime: description: Regime de controle de retenção type: string enum: – CASH – COMPETENCE upDown: description: Up or down type: string enum: – UP – DOWN enumTypeOrder: description: Enumeração para o tipo de ordenação type: string enum: – ASC – DESC enumLotType: description: Tipo de lote type: string enum: – ACCOUNTING – INITIAL_BALANCE userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR arInvoiceData: description: Record nota fiscal de saída 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: type: object allOf: – #/definitions/recCompany description: Dados da empresa branch: type: object allOf: – #/definitions/recBranch description: Dados da filial invoiceNumber: type: integer format: int64 description: Número da nota fiscal minimum: 0 maximum: 999999999 series: type: object allOf: – #/definitions/seriesData description: Série fiscal legalSeries: type: string maxLength: 3 description: Série legal legalSubSeries: type: string maxLength: 2 description: Subsérie legal documentModel: type: object allOf: – #/definitions/documentModelData description: Modelo de documento receiver: type: object allOf: – #/definitions/personData description: Destinatário deliveryAddress: type: object allOf: – #/definitions/addressData description: Endereço de entrega serviceProvisionDate: type: string format: date description: Data de execução do serviço layoffDate: type: string format: date description: Data de emissão outputDate: type: string format: date description: Data de saída admissionManausFreeTradeZoneDate: type: string format: date description: Data da ingresso zona franca de manaus eletronicKey: type: string maxLength: 50 description: Chave eletrônica icmsCalcState: type: object allOf: – #/definitions/stateData description: Estado de cálculo do ICMS issTaxCity: type: object allOf: – #/definitions/cityData description: Cidade de tributação do iss accountingBatchNumber: type: integer format: int64 description: Número do lote contábil situation: type: string allOf: – #/definitions/enumInvoiceSituation description: Situação do documento para escrituração invoiceType: type: string allOf: – #/definitions/enumArInvoiceType description: Tipo da Nota Fiscal origin: type: string allOf: – #/definitions/enumInvoiceOrigin description: Origem da nota fiscal de saída accountingFactOrigin: type: string allOf: – #/definitions/enumInvoiceAccountingFactOrigin description: Origem do fato contábil accountingFact: type: string description: Fato contábil items: type: array items: type: object allOf: – #/definitions/arInvoiceItemsData description: Itens da nota fiscal de saída general: type: object allOf: – #/definitions/invoiceGeneralData description: Dados gerais da nota fiscal de saída carrier: type: object allOf: – #/definitions/arInvoiceCarrierData description: Informações da saída da transportadora financial: type: array items: type: object allOf: – #/definitions/invoiceFinancialData description: Infomações financeiras da nota fiscal messages: type: array items: type: object allOf: – #/definitions/invoiceMessageData description: Mensagens da nota fiscal de saída referencedDocumentInvoice: type: array items: type: object allOf: – #/definitions/invoiceReferencedDocumentData description: Documentos referenciados invoiceTotals: type: object allOf: – #/definitions/invoiceTotalsData description: Totais da nota fiscal arInvoiceSummaryData: description: Resumo da nota fiscal de saída type: object required: – layoffDate – process properties: id: type: string description: Id da nota fiscal de saída companyCode: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 999999999 companyName: type: string description: Nome da empresa branchCode: type: integer format: int64 description: Código da filial minimum: 0 maximum: 999999999 branchName: type: string description: Nome da filial personCode: type: integer format: int64 description: Código do participante minimum: 0 maximum: 999999999 personName: type: string description: Nome do participante series: type: string description: Série da nota fiscal documentModelCode: type: string description: Código do modelo de documento layoffDate: type: string format: date description: Data de emissão invoiceNumber: type: integer format: int64 description: Número da nota fiscal minimum: 0 maximum: 999999999 origin: type: string description: Origem da nota fiscal de saída situation: type: string description: Situação do documento para escrituração bookValue: type: string description: Valor contábil minimum: 0.00 maximum: 9999999999999.99 process: type: string description: Processo recNfSaida: description: Record de resultado da consulta as informações da nota fiscal de saida enviadas pelo serviço nota saída type: object required: – nfSaidaId – codigoEmpresa – nomeEmpresa – codigoFilial – nomeFilial – codigoPessoa – nomePessoa – codigoSerie – modeloDocumento – dataEmissao – origem – situacao – valorContabil – processo properties: nfSaidaId: type: string description: Identificador nota fiscal codigoEmpresa: type: integer format: int64 description: Código da empresa nomeEmpresa: type: string description: Nome empresa codigoFilial: type: integer format: int64 description: Código da filial nomeFilial: type: string description: Nome filial codigoPessoa: type: integer format: int64 description: Código da pessoa nomePessoa: type: string description: Nome da pessoa codigoSerie: type: string description: Código série modeloDocumento: type: string description: Modelo de documento dataEmissao: type: string format: date description: Data de emissão numero: type: integer format: int64 description: Número da nota fiscal origem: type: string allOf: – #/definitions/enumOrigemNfSaida description: Origem da nota fiscal de saída situacao: type: string allOf: – #/definitions/enumNfSaidaSituacao description: Situação do documento para escrituração valorContabil: type: string description: Valor total contábil valorIPI: type: string description: Valor total de IPI valorICMS: type: string description: Valor total de ICMS processo: type: string allOf: – #/definitions/enumNfSaidaProcesso description: Estado do processo da nota invoiceGeneralData: description: Dados gerais da nota fiscal de saída type: object properties: thirdPartyValue: type: string description: Valor em nome de terceiros minimum: 0.00 maximum: 9999999999999.99 default: 0 thirdPartyIssue: type: boolean description: Emissão de terceiros default: false extemporaneousSpedDate: type: string format: date description: Data extemporâneo SPED electronicDocumentSituation: type: string allOf: – #/definitions/enumElectronicDocumentSituation description: Situação do documento eletrônico rpsNumber: type: integer format: int64 description: Número RPS para nota de serviço minimum: 0 maximum: 999999999 arInvoiceCarrierData: description: Informações da nota de saída da transportadora type: object properties: freightType: type: string allOf: – #/definitions/enumFreightType description: Tipo de frete transportMode: type: string allOf: – #/definitions/enumTransportMode description: Via de transporte carrier: type: object allOf: – #/definitions/personData description: Transportadora vehiclePlate: type: string description: Placa do veículo vehicleState: type: object allOf: – #/definitions/stateData description: UF do veiculo grossWeight: type: number format: double description: Peso bruto minimum: 0.00 maximum: 999999.99999 netWeight: type: number format: double description: Peso Líquido minimum: 0.00 maximum: 999999.99999 sender: type: object allOf: – #/definitions/personData description: Remetente senderState: type: object allOf: – #/definitions/stateData description: UF remetente senderStateRegister: type: string maxLength: 25 description: inscrição estadual do remetente senderAddress: type: object allOf: – #/definitions/addressData description: Sequencia endereço de coleta do remetente receiver: type: object allOf: – #/definitions/personData description: Destinatário receiverAddressSequence: type: object allOf: – #/definitions/addressData description: Sequencia endereço de entrega do destinatário consignee: type: object allOf: – #/definitions/personData description: Consignatário invoiceFinancialData: description: Informações financeiras da nota fiscal de saída type: object properties: paymentType: type: object allOf: – #/definitions/paymentTypeData description: Forma de pagamento paymentTerms: type: object allOf: – #/definitions/paymentTermsData description: Condição de pagamento documentTaxType: type: string allOf: – #/definitions/enumDocumentTaxType description: Tipo de titulo fiscal dueDate: type: string format: date description: Data de vencimento do título titleNumber: type: string maxLength: 15 description: Número do título value: type: string description: Valor da parcela cardType: type: string allOf: – #/definitions/enumCardType description: Tipo de cartão complementaryDescription: type: string maxLength: 40 description: Descrição complementar do título arInvoiceItemsData: description: Record itens da nota fiscal de saída type: object required: – sequence – transaction – cfop – printableDescription – quantity properties: itemId: type: string description: Identificador do item da nota fiscal sequence: type: integer format: int64 description: Sequência minimum: 0 maximum: 999 transaction: type: object allOf: – #/definitions/transactionData description: Transação cfop: type: string maxLength: 5 description: CFOP item: type: object allOf: – #/definitions/itemData description: Item asset: type: object allOf: – #/definitions/assetData description: Bem do patrimônio printableDescription: type: string description: Descrição do item para impressão complement: type: string maxLength: 255 description: Complemento ncm: type: object allOf: – #/definitions/ncmData description: Nomenclatura comum do Mercosul (NCM) cestCode: type: string maxLength: 7 description: CEST accountAccounting: type: object allOf: – #/definitions/bookAccountData description: Conta contábil quantity: type: number format: double description: Quantidade minimum: 0.00 maximum: 999999999.99999 measurementUnit: type: object allOf: – #/definitions/measurementUnitData description: Unidade de medida unitPrice: type: string description: Preço unitário minimum: 0.00 maximum: 99999999999.9999999999 commodityValue: type: string description: Valor da mercadoria minimum: 0.00 maximum: 9999999999999.99 discountAmount: type: string description: Valor de desconto minimum: 0.00 maximum: 9999999999999.99 insuranceValue: type: string description: Valor de seguro minimum: 0.00 maximum: 9999999999999.99 costFreight: type: string description: Valor de frete minimum: 0.00 maximum: 9999999999999.99 additionalExpensesValue: type: string description: Valor de despesas acessórias minimum: 0.00 maximum: 9999999999999.99 bookValue: type: string description: Valor contábil minimum: 0.00 maximum: 9999999999999.99 bookAccount: type: object allOf: – #/definitions/bookAccountData description: Conta contábil costCenter: type: object allOf: – #/definitions/costCenterData description: Centro de custo taxes: type: array items: type: object allOf: – #/definitions/invoiceItemsTaxData description: Impostos do item referencedInvoice: type: object allOf: – #/definitions/invoiceReferencedDocumentData description: Documento fiscal referenciado itemMessages: type: array items: type: object allOf: – #/definitions/invoiceMessageData description: Mensagens dos itens da nota fiscal de saída taxArrangements: type: array items: type: object allOf: – #/definitions/invoiceTaxArrangementsData description: Dispositivo fiscal dos itens batchSeries: type: array items: type: object allOf: – #/definitions/invoiceItemsBatchSeriesData description: Lote e série do item da nota invoiceMessageData: description: Mensagens da nota de saída type: object properties: id: type: string description: Id da mensagem code: type: integer format: int64 description: Código da mensagem minimum: 0 maximum: 9999 message: type: string maxLength: 1000 description: Mensagem description: type: string description: Descrição invoiceTaxArrangementsData: description: Dispositivos fiscais da nota fiscal type: object properties: id: type: string description: Id do dispositivo fiscal code: type: integer format: int64 description: Código do dispositivo fiscal minimum: 0 maximum: 999999 invoiceItemsBatchSeriesData: description: Lotes e séries do item da nota type: object properties: expirationDate: type: string format: date description: Data de validade manufacturingDate: type: string format: date description: Data de fabricação batchSerialNumber: type: string maxLength: 50 description: Número do lote batchSerial: type: string allOf: – #/definitions/enumBatchSerial description: Tipo registro serialNumber: type: string maxLength: 50 description: Número da série quantity: type: number format: double description: Quantidade de movimento minimum: 0.00 maximum: 999999999.99999 invoiceItemsTaxData: description: Informação de impostos dos itens da nota fiscal de saída type: object properties: taxType: type: string allOf: – #/definitions/enumTaxType description: Tipo de imposto baseValue: type: string description: Valor Base minimum: 0.00 maximum: 9999999999999.99 default: 0 taxAliquot: type: number format: double description: Alíquota do imposto minimum: 0.00 maximum: 99999999999.9999 taxAmount: type: string description: Valor Imposto minimum: 0.00 maximum: 9999999999999.99 default: 0 otherValues: type: string description: Valor Outras minimum: 0.00 maximum: 9999999999999.99 default: 0 exemptValues: type: string description: Valor Isentas minimum: 0.00 maximum: 9999999999999.99 default: 0 baseReductionPercentage: type: number format: double description: Percentual de redução da base do imposto minimum: 0.00 maximum: 999.99999 deductionAmount: type: string description: Valor de dedução mvaPercentage: type: number format: double description: Percentual da margem de valor agregado do ICMS ST minimum: 0.00 maximum: 999.9999 icmsTaxSituation: type: object allOf: – #/definitions/icmsTaxSituationData description: Situação Tributária ICMS ipiFramework: type: object allOf: – #/definitions/ipiFrameworkData description: Enquadramento de IPI icmsExceptionReason: type: string allOf: – #/definitions/enumIcmsExceptionReason description: Motivo desoneração ICMS commodityOrig: type: string allOf: – #/definitions/enumCommodityOrigin description: Origem fiscal da mercadoria creditCalculationBasis: type: string allOf: – #/definitions/enumCreditCalculationBasis description: Base de cálculo de crédito taxationCode: type: string maxLength: 5 description: Código da tributação incomeNaturePisCofins: type: object allOf: – #/definitions/incomeNaturePisCofinsData description: Natureza pis note: type: string maxLength: 120 description: Observação taxApplication: type: string allOf: – #/definitions/enumTaxApplication description: Aplicação do imposto manualTaxApplication: type: boolean description: Aplicação manual de imposto paymentSlipPerDocument: type: boolean description: Guia por Documento default: false interestateIcmsRate: type: number format: double description: Alíquota de ICMS interestadual da UF de destino minimum: 0.00 maximum: 99999999999.9999 default: 0.00 amountCollected: type: string description: Valor recolhido pelo substituto minimum: 0.00 maximum: 99999999999.9999 supEndConsumer: type: number format: double description: Suportado consumidor final minimum: 0.00 maximum: 99999999999.9999 icmsStRetainedValue: type: string description: Valor Icms St retido minimum: 0.00 maximum: 99999999999.9999 deferralType: type: string allOf: – #/definitions/enumDeferralType description: Tipo de diferimento retentionControlRegime: type: string allOf: – #/definitions/enumRetentionControlRegime description: Regime do controle de retenção nonRecoverableTax: type: string description: Imposto não recuperado minimum: 0.00 maximum: 9999999999999.99 default: 0.0 invoiceTotalsData: description: Totais da nota fiscal type: object properties: bookValue: type: string description: Valor total contábil default: 0.0 discountAmount: type: string description: Valor total de descontos default: 0.0 insuranceValue: type: string description: Valor total do seguro default: 0.0 additionalExpensesValue: type: string description: Valor total de despesas acessórias default: 0.0 commodityValue: type: string description: Valor total da mercadoria minimum: 0.00 maximum: 9999999999999.99 default: 0.0 importFreightValue: type: string description: Valor frete importação default: 0.0 importInsuranceValue: type: string description: Valor seguro importacao default: 0.0 otherImportExpense: type: string description: Valor outras despesas importacao default: 0.0 afrmmValue: type: string description: valor afrmm default: 0.0 invoiceTaxTotals: type: array items: type: object allOf: – #/definitions/invoiceTaxTotalsData description: Totalização dos valores dos impostos da nota para o cabeçalho invoiceTaxTotalsData: description: Totais dos impostos da nota fiscal type: object properties: value: type: string description: Valor do imposto minimum: 0.00 maximum: 9999999999999.99 default: 0.0 base: type: string description: Valor base minimum: 0.00 maximum: 9999999999999.99 default: 0.0 exemptValues: type: string description: Valor de isentas minimum: 0.00 maximum: 9999999999999.99 default: 0.0 otherValues: type: string description: Valor de outras minimum: 0.00 maximum: 9999999999999.99 default: 0.0 taxType: type: string allOf: – #/definitions/enumTaxType description: Tipo de impostos invoiceReferencedDocumentData: description: Documentos e itens referenciados a nota fiscal ou item 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: type: string allOf: – #/definitions/enumReferenceType description: Tipo de referência branch: type: object allOf: – #/definitions/recBranch description: Código da filial documentNumber: type: integer format: int64 description: Número do documento minimum: 0 maximum: 999999999 person: type: object allOf: – #/definitions/personData description: Código do participante series: type: object allOf: – #/definitions/seriesData description: Código da serie itemSequence: type: integer format: int64 description: Sequência do item da nota fiscal minimum: 0 maximum: 999 referencedItemSequence: type: integer format: int64 description: Sequência do item da nota fiscal referenciado minimum: 0 maximum: 999 referencedInvoiceOperation: type: string allOf: – #/definitions/enumReferencedInvoiceOperation description: Operação da nota fiscal referenciada referencedInvoiceEmissionType: type: string allOf: – #/definitions/enumInvoiceEmissionType description: Emissão da nota fiscal referenciada referencedInvoiceKey: type: string maxLength: 50 description: Chave da nota fiscal eletrônica referenciada referencedDocumentModel: type: object allOf: – #/definitions/documentModelData description: Modelo de documento da nota fiscal referenciada legalSeries: type: string maxLength: 2 description: Código da série legal legalSubseries: type: string maxLength: 3 description: Código da subsérie legal issueDateReferencedInvoice: type: string format: date description: Data de emissão da nota fiscal referenciada measurementUnity: type: object allOf: – #/definitions/measurementUnitData description: unidade de medida commodityQuantity: type: number format: double description: Quantidade de mercadorias minimum: 0.00 maximum: 999999999.99999 volumeQuantity: type: integer format: int64 description: Quantidade de volumes grossWeight: type: number format: double description: Peso bruto minimum: 0.00 maximum: 999999999.99999 netWeight: type: number format: double description: Peso Líquido minimum: 0.00 maximum: 999999999.99999 commodityValue: type: string description: Valor mercadoria minimum: 0.00 maximum: 9999999999999.99 totalInvoiceAmount: type: string description: Valor total da nota fiscal minimum: 0.00 maximum: 9999999999999.99 idOrigem: type: string maxLength: 40 description: Id do documento de origem itemIdOrigem: type: string maxLength: 40 description: Id do item do documento de origem apInvoiceData: description: Record nota fiscal de entrada type: object required: – company – branch – series – sender – layoffDate – inputDate – emissionType – situation – invoiceType – accountingFactOrigin properties: id: type: string description: Id da nota de entrada company: type: object allOf: – #/definitions/recCompany description: Dados da empresa branch: type: object allOf: – #/definitions/recBranch description: Dados da filial invoiceNumber: type: integer format: int64 description: Numero da nota fiscal minimum: 0 maximum: 999999999 series: type: object allOf: – #/definitions/seriesData description: Série fiscal legalSeries: type: string maxLength: 3 description: Série legal legalSubSeries: type: string maxLength: 2 description: Subsérie legal documentoModel: type: object allOf: – #/definitions/documentModelData description: Modelo do documento sender: type: object allOf: – #/definitions/personData description: Remetente senderAddress: type: object allOf: – #/definitions/addressData description: Endereço de origem da mercadoria serviceProvisionDate: type: string format: date description: Data execução do serviço layoffDate: type: string format: date description: Data de emissão inputDate: type: string format: date description: Data de entrada emissionType: type: string allOf: – #/definitions/enumInvoiceEmissionType description: Tipo de emissão da nota fiscal eletronicKey: type: string maxLength: 50 description: Chave eletrônica da nota fiscal icmsCalcState: type: object allOf: – #/definitions/stateData description: Estado de cálculo do icms issTaxCity: type: object allOf: – #/definitions/cityData description: Cidade de tributação do iss accountingBatchNumber: type: integer format: int64 description: Número do lote contábil minimum: 0 situation: type: string allOf: – #/definitions/enumInvoiceSituation description: Situação do documento para escrituração invoiceType: type: string allOf: – #/definitions/enumApInvoiceType description: Tipo da nota fiscal accountingFact: type: string description: Fato contábil accountingFactOrigin: type: string allOf: – #/definitions/enumInvoiceAccountingFactOrigin description: Origem do fato contábil items: type: array items: type: object allOf: – #/definitions/apInvoiceItemsData description: Itens da nota fiscal de entrada financial: type: array items: type: object allOf: – #/definitions/invoiceFinancialData description: Informações financeiras da nota de entrada message: type: array items: type: object allOf: – #/definitions/invoiceMessageData description: Mensagens da nota de entrada invoiceImport: type: object allOf: – #/definitions/invoiceImportData description: Informações de importação da nota de entrada general: type: object allOf: – #/definitions/invoiceGeneralData description: Informações Gerais carrier: type: object allOf: – #/definitions/invoiceCarrierData description: Transportadora referencedDocumentInvoice: type: array items: type: object allOf: – #/definitions/invoiceReferencedDocumentData description: Documentos referenciados invoiceTotals: type: object allOf: – #/definitions/invoiceTotalsData description: Totais da nota fiscal apInvoiceItemsData: description: Record itens da nota fiscal de entrada type: object required: – sequence – transaction – cfop – quantity properties: itemId: type: string description: Identificar do item da nota fiscal sequence: type: integer format: int64 description: Sequência minimum: 0 maximum: 999 transaction: type: object allOf: – #/definitions/transactionData description: Transação cfop: type: string maxLength: 5 description: Cfop item: type: object allOf: – #/definitions/itemData description: Item complement: type: string maxLength: 255 description: Complemento ncm: type: object allOf: – #/definitions/ncmData description: Nomenclatura comum do Mercosul (NCM) cestCode: type: string maxLength: 7 description: CEST quantity: type: number format: double description: Quantidade minimum: 0.00 maximum: 999999999.99999 measurementUnit: type: object allOf: – #/definitions/measurementUnitData description: Unidade de medida unitPrice: type: string description: Preço unitário minimum: 0.00 maximum: 99999999999.9999999999 commodityValue: type: string description: Valor da mercadoria minimum: 0.00 maximum: 9999999999999.99 discountAmount: type: string description: Valor de desconto minimum: 0.00 maximum: 9999999999999.99 insuranceValue: type: string description: Valor de seguro minimum: 0.00 maximum: 9999999999999.99 costFreight: type: string description: Valor de frete minimum: 0.00 maximum: 9999999999999.99 additionalExpensesValue: type: string description: Valor de despesas acessórias minimum: 0.00 maximum: 9999999999999.99 bookValue: type: string description: Valor contábil minimum: 0.00 maximum: 9999999999999.99 uncreditedIcmsAmount: type: string description: Valor ICMS não creditado minimum: 0.0 default: 0.0 ownOperationIcmsAmount: type: string description: Valor ICMS operação própria minimum: 0.0 default: 0.0 stOperationIcmsAmount: type: string description: Valor ICMS operação ST minimum: 0.0 default: 0.0 icmsDifalValue: type: string description: Valor ICMS – DIFAL minimum: 0.0 default: 0.0 bookAccount: type: object allOf: – #/definitions/bookAccountData description: Conta contábil costCenter: type: object allOf: – #/definitions/costCenterData description: Centro de custo taxes: type: array items: type: object allOf: – #/definitions/invoiceItemsTaxData description: Impostos batchSeries: type: array items: type: object allOf: – #/definitions/invoiceItemsBatchSeriesData description: Lotes e série invoiceItemImport: type: object allOf: – #/definitions/invoiceItemImport description: Importação taxArrangements: type: array items: type: object allOf: – #/definitions/invoiceTaxArrangementsData description: Dispositivos referencedInvoice: type: object allOf: – #/definitions/invoiceReferencedDocumentData description: Documentos referenciados accountAccounting: type: object allOf: – #/definitions/bookAccountData description: Conta contábil invoiceImportData: description: Informações de importação da nota de entrada type: object properties: importDocumentNumber: type: integer format: int64 description: Número do documento de importação minimum: 0 importType: type: string allOf: – #/definitions/enumImportDeclarationType description: Tipo da declaração de importação recordDate: type: string format: date description: Data do registro do documento de importação customClearanceLocation: type: string maxLength: 60 description: Local onde ocorreu o desembaraço aduaneiro customClearanceDate: type: string format: date description: Data do desembaraço aduaneiro exporter: type: object allOf: – #/definitions/personData description: Código do exportador invoiceItemImport: description: Itens importação type: object properties: importFreightAmount: type: string description: Valor frete importação minimum: 0.0 default: 0.0 importInsuranceAmount: type: string description: Valor seguro importação minimum: 0.0 default: 0.0 otherExpensesAmount: type: string description: Valor de outras despesas minimum: 0.0 default: 0.0 afrmmValue: type: string description: Valor da AFRMM minimum: 0.0 default: 0.0 importDocumentDiscountAmount: type: string description: Valor desconto item DI minimum: 0.0 default: 0.0 drawbackNumber: type: string maxLength: 11 description: Número ato Drawback additionNumber: type: integer format: int64 description: Número da adição minimum: 0 maximum: 999 additionSequence: type: integer format: int64 description: Número da sequência do item adição minimum: 0 maximum: 999 invoiceCarrierData: description: Informações de transportadora da nota de entrada type: object properties: freightType: type: string allOf: – #/definitions/enumFreightType description: Tipo de frete transportMode: type: string allOf: – #/definitions/enumTransportMode description: Via de transporte carrier: type: object allOf: – #/definitions/personData description: Transportadora vehiclePlate: type: string description: Placa do veículo vehicleState: type: object allOf: – #/definitions/stateData description: UF do veiculo grossWeight: type: number format: double description: Peso bruto minimum: 0.00 maximum: 999999.99999 netWeight: type: number format: double description: Peso Líquido minimum: 0.00 maximum: 999999.99999 senderCity: type: object allOf: – #/definitions/cityData description: Código da cidade remetente recipientCity: type: object allOf: – #/definitions/cityData description: Código da cidade destino arInvoiceFilterData: description: Filtros para exclusão de nota fiscal de saída type: object properties: company: type: array items: type: object allOf: – #/definitions/recCompany description: Dados da empresa branch: type: array items: type: object allOf: – #/definitions/recBranch description: Dados da filial documentNumber: type: string maxLength: 14 description: Número CPF / CNPJ nifNumber: type: string maxLength: 255 description: Número do identificador fiscal receiver: type: array items: type: object allOf: – #/definitions/personData description: Dados destinatário series: type: array items: type: object allOf: – #/definitions/seriesData description: Série transaction: type: array items: type: object allOf: – #/definitions/transactionData description: Dados da transação item: type: array items: type: object allOf: – #/definitions/itemData description: Dados do item asset: type: array items: type: object allOf: – #/definitions/assetData description: Dados bem patrimonial initialLayoffDate: type: string format: date description: Data de emissão inicial finalLayoffDate: type: string format: date description: Data de emissão final invoiceNumber: type: integer format: int64 description: Número da nota de saída minimum: 0 maximum: 999999999 origin: type: string allOf: – #/definitions/enumInvoiceOrigin description: Origem da nota fiscal situation: type: string allOf: – #/definitions/enumInvoiceSituation description: Tipos de situação: electronicKey: type: string maxLength: 50 description: Chave da nota apInvoiceFilterData: description: Filtros para exclusão da nota fiscal de entrada type: object properties: company: type: array items: type: object allOf: – #/definitions/recCompany description: Dados da empresa branch: type: array items: type: object allOf: – #/definitions/recBranch description: Dados da filial sender: type: array items: type: object allOf: – #/definitions/personData description: Dados do remetente series: type: array items: type: object allOf: – #/definitions/seriesData description: Série transaction: type: array items: type: object allOf: – #/definitions/transactionData description: Dados da transação initialDateEntry: type: string format: date description: Data de entrada inicial finalDateEntry: type: string format: date description: Data de entrada final invoiceNumber: type: integer format: int64 description: Número da nota de entrada minimum: 0 maximum: 999999999 productItem: type: array items: type: object allOf: – #/definitions/itemData description: Dado do item produto serviceItem: type: array items: type: object allOf: – #/definitions/itemData description: Dado do item serviço origin: type: string allOf: – #/definitions/enumInvoiceOrigin description: Origem da nota fiscal situation: type: string allOf: – #/definitions/enumInvoiceSituation description: Tipos de situação: eletronicKey: type: string maxLength: 50 description: Chave da nota invoicePagedResults: description: Paged results type: object required: – totalPages – totalElements properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de lançamentos encontrados contents: type: array items: type: object allOf: – #/definitions/arInvoiceSummaryData description: Lista com os registros encontrados incomeNaturePisCofinsData: description: Record da natureza de receita para PIS/COFINS type: object properties: id: type: string description: Id da natureza de receita code: type: integer format: int64 description: Código da natureza minimum: 0 maximum: 9999 description: type: string description: Descrição icmsTaxSituationData: description: Record do cadastro de situação tributária type: object properties: id: type: string description: Id da situação tributária code: type: string maxLength: 3 description: Código da situação tributária description: type: string description: Descrição ipiFrameworkData: description: Record do enquadramento de IPI type: object properties: id: type: string description: Id do enquadramento code: type: integer format: int64 description: Código do enquadramento minimum: 0 maximum: 999 description: type: string description: Descrição itemData: description: Record do item da nota fiscal de saída type: object properties: id: type: string description: Id do item code: type: string maxLength: 23 description: Codigo do item itemType: type: string allOf: – #/definitions/enumItemType description: Tipo description: type: string description: Descrição assetData: description: Record do bem patrimonial type: object properties: id: type: string description: Identificador do bem patrimonial code: type: string maxLength: 20 description: Código do bem description: type: string description: Descrição ncmData: description: Cadastro para definição do Nomenclatura comercial do Mercosul(NCM) para os produtos type: object properties: id: type: string description: Id da entidade code: type: string maxLength: 8 description: Nomenclatura comum do Mercosul (NCM) transactionData: description: Record da transação type: object properties: id: type: string description: Identificador da transação code: type: string maxLength: 5 description: Transação description: type: string description: Descrição measurementUnitData: description: Record da unidade de medida do item type: object properties: id: type: string description: Identificador unidade de medida code: type: string maxLength: 6 description: Código da unidade de medida description: type: string description: Descrição bookAccountData: description: Record da conta contábil type: object properties: id: type: string description: Id da entidade code: type: integer format: int64 description: Código da conta contábil minimum: 0 maximum: 9999999 description: type: string description: Descrição costCenterData: description: Record da conta contábil type: object properties: id: type: string description: Id da entidade code: type: string maxLength: 9 description: Código do centro de custos description: type: string description: Descrição countryData: description: Record – Países type: object properties: id: type: string description: Identificador do país code: type: string maxLength: 4 description: Código description: type: string description: Descrição stateData: description: Record – Estados type: object properties: id: type: string description: Identificador do estado code: type: string maxLength: 2 description: Sigla description: type: string description: Descrição cityData: description: Record – Cidades type: object properties: id: type: string description: Id da entidade code: type: integer format: int64 description: Código cidade minimum: 0 maximum: 9999999 cityName: type: string maxLength: 60 description: Nome cidade addressData: description: Endereço type: object properties: id: type: string description: Id do endereço country: type: object allOf: – #/definitions/countryData description: País state: type: object allOf: – #/definitions/stateData description: Estado city: type: object allOf: – #/definitions/cityData description: Cidade description: type: string description: Descrição personData: description: Pessoa type: object properties: id: type: string description: Identificador code: type: integer format: int64 description: Código minimum: 0 maximum: 999999999 documentNumber: type: string maxLength: 14 description: Número do CNPJ ou CPF description: type: string description: Descrição paymentTypeData: description: Record forma de pagamento type: object properties: id: type: string description: Id forma de pagamento code: type: integer format: int64 description: Código da forma de pagamento minimum: 0 maximum: 99 paymentTermsData: description: Record condição de pagamento type: object properties: id: type: string description: Id condição de pagamento code: type: string maxLength: 6 description: Código condição de pagamento documentModelData: description: Record modelo de documento type: object properties: id: type: string description: Id do modelo de documento code: type: string maxLength: 3 description: Código modelo documento description: type: string description: Descrição seriesData: description: Record série fiscal das notas fiscais type: object properties: id: type: string description: Id da série fiscal code: type: string maxLength: 3 description: Código da série fiscal description: type: string description: Descrição recCompany: description: Dados da empresa type: object properties: companyId: type: string description: Identificador da empresa companyCode: type: integer format: int64 description: Código empresa minimum: 0 maximum: 9999 tradeName: type: string description: Nome fantasia recBranch: description: Dados da filial type: object properties: branchId: type: string description: Identificador da filial branchCode: type: integer format: int64 description: Código filial minimum: 0 maximum: 9999 documentNumber: type: string maxLength: 14 description: Número do cnpj ou cpf nifNumber: type: string description: Número do identificador fiscal (nif) tradeName: type: string description: Nome fantasia recProductMask: description: Dados de uma máscara de produto type: object required: – id – code – description – abbreviation – positionQuantity – useComponents – compositionType – autoInc – status properties: id: type: string description: ID do registro code: type: string description: Código da máscara description: type: string description: Descrição da máscara abbreviation: type: string description: Abreviatura da máscara positionQuantity: type: integer format: int64 description: Quantidade de algarismos/caracteres que podem compor a máscara useComponents: type: boolean description: Indicativo se a máscara utiliza componentes compositionType: type: string description: Indicativo do tipo de composição da máscara autoInc: type: boolean description: Indicativo se a máscara é autoincrementável, isto é, se seu valor é sequencial ou não status: type: string description: Situação máscara fixedSequency: type: string maxLength: 10 description: Valor da sequência fixa userCanSelect: type: boolean description: Indicativo se permite informar/selecionar um valor checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck recFieldsOrderBy: description: Definição de campo a ser ordenado type: object required: – field – order properties: field: type: string description: Nome do campo a ser ordenado order: type: string allOf: – #/definitions/enumTypeOrder description: Tipo de ordenação do campo (ASC / DESC) recPageRequest: description: Record de paginação e ordenação de registros type: object required: – offset – size properties: offset: type: integer format: int64 description: Página atual size: type: integer format: int64 description: Total de páginas orderBy: type: array items: type: object allOf: – #/definitions/recFieldsOrderBy description: Campos da ordenação dos registros a serem pesquisados recPagedResults: description: Paged results type: object required: – totalPages – totalElements properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de lançamentos encontrados contents: type: array items: type: object allOf: – #/definitions/recMonthlyInformation description: Lista com os registros encontrados recMonthlyInformation: description: Informações mensais type: object required: – id – company – branch – competence – pisValue – costCenter properties: id: type: string description: Identificador company: type: object allOf: – #/definitions/recCompany description: Dados da empresa branch: type: object allOf: – #/definitions/recBranch description: Dados da filial competence: type: string maxLength: 7 description: Data competência numberStaff: type: integer format: int64 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 costCenter: type: object allOf: – #/definitions/costCenterData description: Dados do centro de custo companyIdentifier: description: Dados de identificação da empresa type: object properties: id: type: string description: Identificador único da empresa code: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 branchIdentifier: description: Dados de identificação da filial type: object properties: id: type: string description: Identificador único da filial code: type: integer format: int64 description: Codigo da filial minimum: 0 maximum: 9999 documentNumber: type: string maxLength: 14 description: Número do CNPJ ou CPF nifNumber: type: string maxLength: 40 description: Número de identificação fiscal accountingLotIdentifier: description: Dados do lote contábil type: object required: – code properties: company: type: object allOf: – #/definitions/companyIdentifier description: Dados da empresa id: type: string description: Identificador do lote code: type: string description: Código do lote accountingEntryData: description: Dados do lançamento contábil type: object required: – accountingEntryDate – value – defaultHistory properties: internalIdentifier: type: string description: Identificador interno do lançamento contábil documentControlNumber: type: string maxLength: 12 description: Número de documento de controle (Identificador externo) accountingEntryDate: type: string format: date description: Data do lançamento debitBookAccount: type: object allOf: – #/definitions/accountEntryIdentifier description: Dados da conta contábil de débito creditBookAccount: type: object allOf: – #/definitions/accountEntryIdentifier description: Dados da conta contábil de crédito value: type: string description: Valor do lançamento contábil note: type: string description: Observação extemporaneousDate: type: string format: date description: Data extemporânea defaultHistory: type: string description: Descrição do histórico padrão fact: type: string description: Fato contábil do lançamento accountEntryIdentifier: description: Conjunto de informações relacionadas à conta contábil type: object required: – account properties: account: type: object allOf: – #/definitions/identifier description: Conta contábil assessments: type: array items: type: object allOf: – #/definitions/assessmentData description: Rateios da conta contábil auxiliaries: type: array items: type: object allOf: – #/definitions/auxiliaryData description: Lançamentos auxiliares da conta contábil documentNumber: type: string maxLength: 14 description: CPF / CNPJ relacionado à conta contábil assessmentData: description: Dados de Rateio type: object required: – costCenter – value – percentage properties: costCenter: type: object allOf: – #/definitions/identifier description: Centro de Custo value: type: string description: Valor minimum: 0.00 maximum: 9999999999.99 percentage: type: string description: Percentual auxiliaryData: description: Dados de lançamento auxiliar type: object required: – auxiliaryAccount – value properties: auxiliaryAccount: type: object allOf: – #/definitions/identifier description: Identificação da conta auxiliar value: type: string description: Valor minimum: 0.00 maximum: 9999999999.99 identifier: description: Dados para identificação de um recurso type: object properties: id: type: string description: Identificador code: type: string description: Código company: description: type: object properties: id: type: string format: uuid description: createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: productFamily: description: type: object properties: id: type: string format: uuid description: createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: spendingNature: description: type: object properties: id: type: string format: uuid description: createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: statusReason: description: type: object properties: id: type: string format: uuid description: createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: groupingSalesQuotas: description: type: object properties: id: type: string format: uuid description: createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: measureUnit: description: type: object properties: id: type: string format: uuid description: createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: ncm: description: type: object properties: id: type: string format: uuid description: createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: product: description: Produto – derivação type: object required: – company – family – derivationCode – description – status properties: id: type: string format: uuid description: Id da entidade company: type: object allOf: – #/definitions/company description: Empresa family: type: object allOf: – #/definitions/productFamily description: Família derivationCode: type: string maxLength: 23 description: Derivação description: type: string maxLength: 50 description: Descrição additionalDescription: type: string maxLength: 50 description: Descrição complementar barcode: type: string maxLength: 13 description: Código de barras freeBarcode: type: string maxLength: 30 description: Código barras livre gtinBarcode: type: string maxLength: 14 description: Gtin uni. trib productIdentification: type: string maxLength: 20 description: Identificação produto grossWeight: type: number format: double description: Peso bruto minimum: 0.00 maximum: 999999.99999 netWeight: type: number format: double description: Peso líquido minimum: 0.00 maximum: 999999.99999 referenceCode: type: string maxLength: 40 description: Código da Referência spendingNature: type: object allOf: – #/definitions/spendingNature description: Natureza de gasto status: type: string description: Situação statusReason: type: object allOf: – #/definitions/statusReason description: Motivo da situação productFramework: type: string description: Enquadramento de produto específico deleted: type: boolean description: Indica se o registro foi excluído default: false gtinCodeSearchType: type: string description: Forma de busca do código GTIN para gerar as tags cEAN e cEANTrib groupingSalesQuotas: type: object allOf: – #/definitions/groupingSalesQuotas description: Agrupamento Cotas Venda baseQuantityForPriceCalculation: type: number format: double description: Quantidade Base para Cálculo de Preço minimum: 0.00 maximum: 999999999.99999 productSoldSeparately: type: boolean description: Produto vendido separadamente? anvisaRegistrationNumber: type: string maxLength: 13 description: Número registro Anvisa reasonForAnvisaExemption: type: string maxLength: 255 description: Motivo da isenção da Anvisa productCanBeSold: type: boolean description: Indicativo se o produto pode ser vendido default: false productPerCustomer: type: boolean description: Produto por Cliente default: false multiSalesQuantity: type: number format: double description: Quantidade Múltipla Vendas minimum: 0.00 maximum: 9999999.99999 priceGrouping: type: string maxLength: 5 description: Agrup. Preço commissioned: type: boolean description: Comissionado ? measureUnit: type: string maxLength: 3 description: Unidade Medida (Cálculo de preço) percentageNaturalGas: type: number format: double description: % Gás Natural minimum: 0.00 maximum: 999.99 customProduct: type: boolean description: Produto Sob Encomenda percentageInGLPProduct: type: number format: double description: Percentual do GLP derivado do petróleo no produto GLP minimum: 0.00 maximum: 999.99 percentageOfImportedNaturalGas: type: number format: double description: Percentual de Gás Natural Importado – GLGNi para o produto GLP minimum: 0.00 maximum: 999.99 thirdMeasureUnit: type: object allOf: – #/definitions/measureUnit description: 3ª Unidade Medida notaFiscalDescription: type: string maxLength: 120 description: Descrição p/ Nota Fiscal additionalInformationForNotaFiscal: type: string maxLength: 500 description: Informações adicionais do produto para NF-e taxCode: type: string maxLength: 60 description: Código fiscal taxDescription: type: string maxLength: 255 description: Descrição fiscal ncm: type: object allOf: – #/definitions/ncm description: NCM taxProductType: type: string description: Tipo Produto para Impostos productCodeForANP: type: integer format: int64 description: Código de produto ANP productDescriptionForANP: type: string maxLength: 95 description: Descrição do produto conforme ANP taxOriginOfGoods: type: string description: Origem fiscal da mercadoria taxSubstitutionSpecifier: type: string maxLength: 7 description: Especificador substituição tributária generateGroupForIcmsStInNFeWithCST60: type: boolean description: Gerar grupo de repasse de ICMS ST na NF-e mesmo com CST 60 default: false pepsControl: type: boolean description: controla PEPs default: false producedOnRelevantScale: type: boolean description: Produzido em escala relevante default: true createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: currency: description: type: object required: – currencyCode – currencyDescription – currencyAcronym – currencyType – currencyQuoteType properties: id: type: string format: uuid description: currencyCode: type: string maxLength: 3 description: currencyDescription: type: string maxLength: 30 description: currencyAcronym: type: string maxLength: 5 description: currencyType: type: string description: currencyQuoteType: type: string description: createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: country: description: type: object required: – countryCode – countryName properties: id: type: string format: uuid description: countryCode: type: string description: countryName: type: string description: countryCurrency: type: object allOf: – #/definitions/currency description: createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service 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