integration

2.0info: 1.8.0 integration description: integration x-senior-domain: erpx_com_fat x-senior-domain-path: erpx_com_fat x-senior-service-path: integration 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/erpx_com_fatsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /integration/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 /integration/queries/eligibleToExclude: post: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para verificar se um registro de uma tabela é elegível para exclusão tags: – Queries x-senior-visibility: PRIVATE parameters: – name: entityName description: Nome da entidade in: query required: true type: string – name: id description: Id do registro in: query required: true type: string responses: 200: description: Ok schema: type: object required: – eligible properties: eligible: type: boolean description: Indica se o registro é elegível para exclusão notEligibleMessage: type: string description: Mensagem quando o registro não estiver elegível para exclusão unkownEntity: type: boolean description: Indica se a entidade é desconhecida pelo serviço 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/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 /integration/queries/exportExternalInvoiceIntegration: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /integration/queries/exportE140nfs: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /integration/queries/exportE140inf: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /integration/queries/exportE140ide: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /integration/queries/exportE070fil: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /integration/queries/exportE070emp: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /integration/queries/exportModulos: post: description: tags: – Queries x-senior-visibility: PRIVATE 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 /integration/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE 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: PRIVATE 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 /integration/actions/softExclude: post: description: Realiza a exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/undoSoftExclude: post: description: Realiza a compensação da exclusão lógica para o registro de uma tabela tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: entityName: type: string description: Nome da entidade id: type: string description: Id do registro responses: 200: description: Ok schema: type: object required: – deleted properties: deleted: type: boolean description: Indica se o registro está/foi excluído errorMessage: type: string description: Mensagem de erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/actions/createPointOfSaleInvoice: post: description: Cria uma nota fiscal de consumidor com os dados informados\n### Resources\n- res://senior.com.br/erpx_com_fat/integration/actions/manageInvoice tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – pointOfSaleInvoice properties: pointOfSaleInvoice: type: object allOf: – #/definitions/pointOfSaleInvoice description: Informações da nota fiscal de ponto de venda responses: 200: description: Ok schema: type: object 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: Registro não localizado através do ID ERPX ou chave de negócio informados default: description: Error response schema: #/definitions/genericError /integration/actions/createAuthorizedInvoice: post: description: Cria uma nota fiscal com os dados informados\n### Resources\n- res://senior.com.br/erpx_com_fat/integration/actions/manageInvoice tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – authorizedInvoice properties: authorizedInvoice: type: object allOf: – #/definitions/authorizedInvoice description: Informações da nota fiscal responses: 200: description: Ok schema: type: object 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: Registro não localizado através do ID ERPX ou chave de negócio informados default: description: Error response schema: #/definitions/genericError /integration/actions/cancelInvoice: post: description: Cancela uma nota fiscal com os dados informados\n### Resources\n- res://senior.com.br/erpx_com_fat/integration/actions/manageInvoice tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: id: type: string description: Id da nota fiscal no ERPX externalId: type: string description: Identificação externa da nota cancelingReason: type: string description: Justificativa de cancelamento cancelProtocolNumber: type: string maxLength: 15 description: Número do protocolo de cancelamento do documento eletrônico cancelAuthorizationDate: type: string format: date-time description: Data e hora de cancelamento do documento eletrônico saleOrderChargeback: type: string allOf: – #/definitions/saleOrderChargeback description: Tipo de estorno do pedido de venda installmentChargeback: type: string allOf: – #/definitions/installmentChargeback description: Tipo de estorno da competência do contrato responses: 200: description: Ok schema: type: object 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: Registro não localizado através do ID ERPX ou chave de negócio informados default: description: Error response schema: #/definitions/genericError /integration/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 /integration/actions/importExternalInvoiceIntegration: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /integration/actions/importE140nfs: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /integration/actions/importE140inf: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /integration/actions/importE140ide: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /integration/actions/importE070fil: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /integration/actions/importE070emp: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /integration/actions/importModulos: post: description: tags: – Actions x-senior-visibility: PRIVATE 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 /integration/events/generateExternalInvoice: post: description: Evento para geração de nota fiscal externa x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – branch – customer – serie – items – externalInvoiceId properties: company: type: object allOf: – #/definitions/company description: Dados da empresa branch: type: object allOf: – #/definitions/branch description: Filial da venda issueDate: type: string format: date-time description: Data e hora da emissão da nota fiscal productTransaction: type: object allOf: – #/definitions/transaction description: Transação de produto serviceTransaction: type: object allOf: – #/definitions/transaction description: Transação de serviço customer: type: object allOf: – #/definitions/customer description: Cliente representative: type: object allOf: – #/definitions/representative description: Representante serie: type: object allOf: – #/definitions/serie description: Série number: type: string description: Número da nota rpsNumber: type: integer format: int64 description: Numero da RPS items: type: array items: type: object allOf: – #/definitions/recItem minimum: 1 description: Itens da nota fiscal grossValue: type: string description: Valor bruto total da nota netValue: type: string description: Valor liquido total da nota financialValue: type: string description: Valor financeiro total da nota transportInformation: type: object allOf: – #/definitions/transportInformation description: Informações de transporte additionalInformation: type: object allOf: – #/definitions/additionalInformation description: Informações adicionais billingInformation: type: object allOf: – #/definitions/billingInformation description: Informações de cobrança referencedDocument: type: object allOf: – #/definitions/referencedDocument description: Informações de referência electronicInformation: type: object allOf: – #/definitions/eletronicInformation description: Informações do documento eletrônico authorizedInvoice: type: boolean description: Nota fiscal autorizada default: false automaticallyClosing: type: boolean description: Fechamento automático default: false automaticallyIssue: type: boolean description: Emissão automática default: true externalInvoiceId: type: string description: Identificador externo da nota fiscal proveniente de integração invoiceType: type: string allOf: – #/definitions/enumInvoiceType description: Tipo da nota fiscal responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/cancelExternalInvoiceIntegrationSuccess: post: description: Evento de cancelamento da nota fiscal x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object properties: id: type: string description: Id da nota fiscal no ERPX cancelingReason: type: string description: Justificativa de cancelamento cancelProtocolNumber: type: string maxLength: 15 description: Número do protocolo de cancelamento do documento eletrônico cancelAuthorizationDate: type: string format: date-time description: Data e hora de cancelamento do documento eletrônico saleOrderChargeback: type: string allOf: – #/definitions/saleOrderChargeback description: Tipo de estorno do pedido de venda installmentChargeback: type: string allOf: – #/definitions/installmentChargeback description: Tipo de estorno da competência do contrato responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /integration/events/importExternalInvoiceIntegrationEvent: 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 /integration/events/exportExternalInvoiceIntegrationEvent: 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 /integration/events/importE140nfsEvent: 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 /integration/events/exportE140nfsEvent: 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 /integration/events/importE140infEvent: 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 /integration/events/exportE140infEvent: 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 /integration/events/importE140ideEvent: 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 /integration/events/exportE140ideEvent: 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 /integration/events/importE070filEvent: 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 /integration/events/exportE070filEvent: 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 /integration/events/importE070empEvent: 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 /integration/events/exportE070empEvent: 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 /integration/events/importModulosEvent: 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 /integration/events/exportModulosEvent: 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 /integration/entities/externalInvoiceIntegration: 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/externalInvoiceIntegration responses: 200: description: The created resource schema: #/definitions/externalInvoiceIntegration 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/externalInvoiceIntegration responses: 200: description: The created resource schema: #/definitions/externalInvoiceIntegration 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/externalInvoiceIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/externalInvoiceIntegration/{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/editExternalInvoiceIntegration responses: 200: description: Ok schema: #/definitions/editExternalInvoiceIntegration 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/externalInvoiceIntegration responses: 200: description: Ok schema: #/definitions/externalInvoiceIntegration 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/externalInvoiceIntegration 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 /integration/entities/externalInvoiceIntegration/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/externalInvoiceIntegration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e140nfs: 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e140nfs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e140nfs/{id}: 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/e140nfs 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e140inf: 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e140inf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e140inf/{id}: 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/e140inf 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e140ide: 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e140ide 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e140ide/{id}: 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/e140ide 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e070fil: 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e070fil/{id}: 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/e070fil 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e070emp: 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/e070emp/{id}: 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/e070emp 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/modulos: 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/modulos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /integration/entities/modulos/{id}: 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/modulos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: upDown: type: string enum: – UP – DOWN description: Up or down: * `UP` – Up * `DOWN` – Down enumExternalInvoiceStatus: type: string enum: – IN_PROGRESS – INVOICE_CREATED – FINISHED – ERROR – EVENT_ERROR description: Status da integração: * `IN_PROGRESS` – Em processamento * `INVOICE_CREATED` – Nota fiscal criada * `FINISHED` – Nota fiscal criada * `ERROR` – Nota fiscal com erro * `EVENT_ERROR` – Erro no processamento dos eventos da nota fiscal enumExternalInvoiceIntegration: type: string enum: – PDV – API description: Identificador da origem integração externa: * `PDV` – PDV * `API` – API de nota fiscal enumModulos: type: string enum: – CONTROLADORIA – MANUFATURA – ECOMMERCE – MRP – RMS – FLUXO_CAIXA – DRP – CRM – PDV – QUALIDADE description: Módulos que podem ser adquiridos pelo cliente: * `CONTROLADORIA` – Controladoria * `MANUFATURA` – Manufatura * `ECOMMERCE` – e-Commerce * `MRP` – MRP * `RMS` – Roteirização(RMS) * `FLUXO_CAIXA` – Fluxo de caixa * `DRP` – DRP * `CRM` – CRM * `PDV` – Integração PDV * `QUALIDADE` – Qualidade enumInvoiceType: type: string enum: – PRODUCT_SALE – COMPLEMENTARY – ADJUSTMENT – PRODUCT_RETURN – SHIPMENT – RETURN – TRANSFER – PRODUCT_SERVICE_SALE – REVERSAL – SERVICE_SALE – SUBSTITUTE – SERVICE_CANCELLATION – MERCHANDISE_BILLING – MERCHANDISE_DELIVERY – OTHER_OPERATIONS taxType: type: string enum: – IPI – IPI_PRESUMIDO – IPI_DEVOLVIDO – IPI_CREDITADO – ICMS – ICMS_SIMPLES – ICMS_FUTURO – ICMS_DIFERIDO – ICMS_DESONERADO – ICMS_ST – ICMS_UF_DESTINO – ICMS_ISENTAS_OUTRAS – ICMS_CREDITADO – ICMS_EFETIVO – ICMS_ST_RETIDO_ANT – ICMS_ST_FUTURO – ICMS_ST_SOLIDARIO – ICMS_IMPORTACAO – ICMS_DESTINO – FCP – FCP_ST – FCP_UF_DESTINO – FCP_ST_RETIDO_ANT – ISS – COFINS – COFINS_RETIDO – COFINS_RECUPERAR_IMPORTACAO – COFINS_RECUPERAR – COFINS_DEVOLVIDO – PIS – PIS_RETIDO – PIS_RECUPERAR_IMPORTACAO – PIS_RECUPERAR – PIS_DEVOLVIDO – CSLL – ISS_RETIDO – IRRF – INSS – INSS_PATRONAL – IMPOSTO_IMPORTACAO – DIFAL – DIFAL_DEVOLVIDO – CIDE_TECNOLOGIA – CBS – CBS_DIFERIDO – CBS_CREDITO_PRESUMIDO – CBS_TRIBUTACAO_REGULAR – IBS_ESTADUAL – IBS_ESTADUAL_DIFERIDO – IBS_ESTADUAL_CREDITO_PRESUMIDO – IBS_ESTADUAL_TRIBUTACAO_REGULAR – IBS_MUNICIPAL – IBS_MUNICIPAL_DIFERIDO – IBS_MUNICIPAL_TRIBUTACAO_REGULAR – IS description: Tipo de imposto documento: * `IPI` – IPI * `IPI_PRESUMIDO` – IPI presumido * `IPI_DEVOLVIDO` – IPI devolvido * `IPI_CREDITADO` – IPI efetivamente creditado * `ICMS` – ICMS Normal * `ICMS_SIMPLES` – ICMS Simples Nacional * `ICMS_FUTURO` – ICMS Futuro * `ICMS_DIFERIDO` – ICMS Diferido * `ICMS_DESONERADO` – ICMS Desonerado * `ICMS_ST` – ICMS ST * `ICMS_UF_DESTINO` – ICMS na UF de destino (DIFAL) * `ICMS_ISENTAS_OUTRAS` – ICMS Isentas/Outras * `ICMS_CREDITADO` – ICMS Creditado * `ICMS_EFETIVO` – ICMS efetivo * `ICMS_ST_RETIDO_ANT` – ICMS ST retido anteriormente * `ICMS_ST_FUTURO` – ICMS ST futuro * `ICMS_ST_SOLIDARIO` – ICMS ST solidário * `ICMS_IMPORTACAO` – ICMS na importação * `ICMS_DESTINO` – ICMS destino * `FCP` – Fundo de Combate à Pobreza * `FCP_ST` – Fundo de Combate à Pobreza retido por Substituição Tributária * `FCP_UF_DESTINO` – Fundo de Combate à Pobreza na UF de destino (DIFAL) * `FCP_ST_RETIDO_ANT` – Fundo de Combate à Pobreza retido anteriormente por Substituição Tributária * `ISS` – ISS * `COFINS` – COFINS Faturamento * `COFINS_RETIDO` – COFINS Retido * `COFINS_RECUPERAR_IMPORTACAO` – COFINS a recuperar na importação * `COFINS_RECUPERAR` – COFINS a recuperar (devolução de compra) * `COFINS_DEVOLVIDO` – COFINS estornado na devolução * `PIS` – PIS Faturamento * `PIS_RETIDO` – PIS Retido * `PIS_RECUPERAR_IMPORTACAO` – PIS a recuperar na importação * `PIS_RECUPERAR` – PIS a recuperar (devolução de compra) * `PIS_DEVOLVIDO` – PIS estornado na devolução * `CSLL` – CSLL * `ISS_RETIDO` – ISS Retido * `IRRF` – IRRF * `INSS` – INSS * `INSS_PATRONAL` – INSS Patronal * `IMPOSTO_IMPORTACAO` – Imposto de importação * `DIFAL` – Diferencial de alíquota (devolução de compra) * `DIFAL_DEVOLVIDO` – DIFAL estornado na devolução * `CIDE_TECNOLOGIA` – CIDE Tecnologia * `CBS` – CBS * `CBS_DIFERIDO` – CBS Diferido * `CBS_CREDITO_PRESUMIDO` – CBS Presumido * `CBS_TRIBUTACAO_REGULAR` – CBS Tributação Regular * `IBS_ESTADUAL` – IBS Estadual * `IBS_ESTADUAL_DIFERIDO` – IBS Estadual Diferido * `IBS_ESTADUAL_CREDITO_PRESUMIDO` – IBS Estadual Presumido * `IBS_ESTADUAL_TRIBUTACAO_REGULAR` – IBS Estadual Tributação Regular * `IBS_MUNICIPAL` – IBS Municipal * `IBS_MUNICIPAL_DIFERIDO` – IBS Municipal Diferido * `IBS_MUNICIPAL_TRIBUTACAO_REGULAR` – IBS Municipal Tributação Regular * `IS` – Imposto Seletivo consumerPresence: type: string enum: – NOT_APPLY – PRESENTIAL – NOT_PRESENTIAL_INTERNET – NOT_PRESENTIAL_TELESERVICE – NFCE_DELIVERY – PRESENTIAL_OUTSIDE – NOT_PRESENTIAL_OTHERS description: Indicativo de presença do consumidor: * `NOT_APPLY` – Não se aplica * `PRESENTIAL` – Operação presencial * `NOT_PRESENTIAL_INTERNET` – Operação não presencial, pela Internet * `NOT_PRESENTIAL_TELESERVICE` – Operação não presencial, Teleatendimento * `NFCE_DELIVERY` – NFC-e em operação com entrega em domicílio * `PRESENTIAL_OUTSIDE` – Operação presencial, fora do estabelecimento * `NOT_PRESENTIAL_OTHERS` – Operação não presencial, outros integrationTypeInstallment: type: string enum: – TEF – POS – ECOMMERCE description: Tipo de Integração: * `TEF` – TEF * `POS` – POS * `ECOMMERCE` – e-Commerce cardBrand: type: string enum: – VISA – MASTERCARD – AMERICAN_EXPRESS – SOROCRED – DINERS_CLUB – ELO – HIPERCARD – AURA – CABAL – ALELO – BANES_CARD – CALCARD – CREDZ – DISCOVER – GOODCARD – GREENCARD – HIPER – JCB – MAIS – MAXVAN – POLICARD – REDECOMPRAS – SODEXO – VALECARD – VEROCHEQUE – VR – TICKET – OUTROS description: Bandeira da operadora de cartão de crédito/débito: * `VISA` – Visa * `MASTERCARD` – Mastercard * `AMERICAN_EXPRESS` – American Express * `SOROCRED` – Sorocred * `DINERS_CLUB` – Diners Club * `ELO` – Elo * `HIPERCARD` – Hipercard * `AURA` – Aura * `CABAL` – Cabal * `ALELO` – Alelo * `BANES_CARD` – Banes Card * `CALCARD` – CalCard * `CREDZ` – Credz * `DISCOVER` – Discover * `GOODCARD` – GoodCard * `GREENCARD` – GreenCard * `HIPER` – Hiper * `JCB` – JcB * `MAIS` – Mais * `MAXVAN` – MaxVan * `POLICARD` – Policard * `REDECOMPRAS` – RedeCompras * `SODEXO` – Sodexo * `VALECARD` – ValeCard * `VEROCHEQUE` – Verocheque * `VR` – VR * `TICKET` – Ticket * `OUTROS` – Outros paymentMethodType: type: string enum: – CASH_PAYMENT – TERM_PAYMENT description: Tipo da forma de pagamento: * `CASH_PAYMENT` – Pagamento à Vista * `TERM_PAYMENT` – Pagamento à Prazo productTaxOrigin: type: string enum: – V0 – V1 – V2 – V3 – V4 – V5 – V6 – V7 – V8 description: Origem fiscal da mercadoria: * `V0` – 0 – Nacional, exceto as indicadas nos códigos 3, 4, 5 e 8 * `V1` – 1 – Estrangeira – Importação direta, exceto a indicada no código 6 * `V2` – 2 – Estrangeira – Adquirida no mercado interno, exceto a indicada no código 7 * `V3` – 3 – Nacional, mercadoria ou bem com Conteúdo de Importação superior a 40% (quarenta por cento) e inferior ou igual a 70% (setenta por cento) * `V4` – 4 – Nacional, cuja produção tenha sido feita em conformidade com os processos produtivos básicos de que tratam o Decreto-Lei nº 288/67, e as Leis nºs 8.248/91, 8.387/91, 10.176/01 e 11.484/07 * `V5` – 5 – Nacional, mercadoria ou bem com Conteúdo de Importação inferior ou igual a 40% (quarenta por cento) * `V6` – 6 – Estrangeira – Importação direta, sem similar nacional, constante em lista de Resolução CAMEX e gás natural * `V7` – 7 – Estrangeira – Adquirida no mercado interno, sem similar nacional, constante em lista de Resolução CAMEX e gás natural * `V8` – 8 – Nacional, mercadoria ou bem com Conteúdo de Importação superior a 70% (setenta por cento) cifFob: type: string enum: – CIF – FOB – THIRD_PARTIES – OWN_SENDER – OWN_DESTINATION – NO_TRANSPORT description: Tipo de frete: * `CIF` – Contratação do frete por conta do remetente (CIF) * `FOB` – Contratação do frete por conta do destinatário (FOB) * `THIRD_PARTIES` – Contratação do frete por conta de terceiros * `OWN_SENDER` – Transporte próprio por conta do remetente * `OWN_DESTINATION` – Transporte próprio por conta do destinatário * `NO_TRANSPORT` – Sem ocorrência de transporte indicativeIntermediation: type: string enum: – WITHOUT_INTERMEDIARY – THIRD_PARTY_PLATFORM – NOT_APPLICABLE description: Indicativo de intermediação: * `WITHOUT_INTERMEDIARY` – Operação sem intermediador (em site ou plataforma própria) * `THIRD_PARTY_PLATFORM` – Operação em site ou plataforma de terceiros (intermediadores/marketplace) * `NOT_APPLICABLE` – Não se aplica externalIntegrationProcess: type: string enum: – CREATE – CANCEL description: Tipo de processo de integração externa: * `CREATE` – Criação de nota fiscal * `CANCEL` – Cancelamento de nota fiscal saleOrderChargeback: type: string enum: – CANCEL_ORDER_ITEMS – AVAILABLE_FOR_REBILLING – REHABILITATE_INVOICE description: Tipo de estorno do pedido de venda: * `CANCEL_ORDER_ITEMS` – Cancelar os itens do pedido * `AVAILABLE_FOR_REBILLING` – Disponibilizar os itens do pedido para novo faturamento * `REHABILITATE_INVOICE` – Reabilitação da nota fiscal de saída installmentChargeback: type: string enum: – CANCEL_INSTALLMENT – AVAILABLE_FOR_NEW_BILLING description: Tipo de estorno do contrato: * `CANCEL_INSTALLMENT` – Cancelar a competência * `AVAILABLE_FOR_NEW_BILLING` – Disponibilizar competência para novo faturamento userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error 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 pointOfSaleInvoice: description: Informações da nota fiscal de ponto de venda allOf: – #/definitions/baseInvoice – type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/pdvItem minimum: 1 description: Itens da nota fiscal authorizedInvoice: description: Informações da nota fiscal de ponto de venda allOf: – #/definitions/baseInvoice – type: object required: – items properties: items: type: array items: type: object allOf: – #/definitions/invoiceItem minimum: 1 description: Itens da nota fiscal transportInformation: type: object allOf: – #/definitions/transportInformation description: Informações de transporte invoiceType: type: string allOf: – #/definitions/enumInvoiceType description: Tipo da nota fiscal baseInvoice: description: Informações gerais da nota fiscal de ponto de venda discriminator: _discriminator type: object required: – externalInvoiceId – branch – issueDate – customer – serie – accessKey – protocolNumber – authorizationDate – _discriminator properties: externalInvoiceId: type: string description: Identificador externo da nota fiscal proveniente de integração company: type: object allOf: – #/definitions/company description: Dados da empresa branch: type: object allOf: – #/definitions/branch description: Filial da venda issueDate: type: string format: date-time description: Data e hora da emissão da nota fiscal productTransaction: type: object allOf: – #/definitions/transaction description: Transação produto customer: type: object allOf: – #/definitions/customer description: Cliente saleRepresentative: type: object allOf: – #/definitions/representative description: Representante serie: type: object allOf: – #/definitions/serie description: Série number: type: string description: Número da nota invoiceNote: type: string description: Observação consumerPresence: type: string allOf: – #/definitions/consumerPresence description: Indicativo de presença do consumidor additionalValues: type: object allOf: – #/definitions/additionalValues description: Valores adicionais grossValue: type: string description: Valor bruto total da nota netValue: type: string description: Valor liquido total da nota financialValue: type: string description: Valor financeiro total da nota invoiceAdditionalInformation: type: string description: Informações complementares para documento fiscal paymentTermId: type: string description: Id da condição de pagamento installments: type: array items: type: object allOf: – #/definitions/invoiceInstallment description: Parcelas accessKey: type: string maxLength: 50 description: Chave do documento eletrônico protocolNumber: type: string maxLength: 100 description: Número do protocolo de autorização do documento eletrônico authorizationDate: type: string format: date-time description: Data e hora de autorização do documento eletrônico _discriminator: type: string description: company: description: Informações da empresa type: object properties: id: type: string description: Id da empresa code: type: string description: Código da empresa branch: description: Informações da filial type: object properties: id: type: string description: Id da filial code: type: string description: Código da filial transaction: description: Informações da transação type: object properties: id: type: string description: Id da transação code: type: string description: Código da transação person: description: Informações de pessoa allOf: – #/definitions/defaultInformation – type: object properties: taxNumber: type: string description: CPF/CNPJ customer: description: Informações do cliente type: object properties: id: type: string description: Id da pessoa code: type: string description: Código da pessoa taxNumber: type: string description: CPF/CNPJ representative: description: Informações do representante type: object properties: id: type: string description: Id da pessoa code: type: string description: Código da pessoa serie: description: Informações da série type: object properties: id: type: string description: Id da série code: type: string description: Código da série pdvItem: description: Informações do item da nota allOf: – #/definitions/baseItem – type: object invoiceItem: description: Informações do item da nota allOf: – #/definitions/baseItem – type: object properties: transportValues: type: object allOf: – #/definitions/transportValues description: Valores de transporte recItem: description: Informações do item da nota para evento interno allOf: – #/definitions/baseItem – type: object properties: transportValues: type: object allOf: – #/definitions/transportValues description: Valores de transporte baseItem: description: Informações do item da nota discriminator: _discriminator type: object required: – productId – saleMeasureUnit – saleQuantity – salePrice – _discriminator properties: productId: type: string description: Id do produto do item transaction: type: object allOf: – #/definitions/transaction description: Transação do item saleMeasureUnit: type: object allOf: – #/definitions/measureUnit description: Unidade de medida de venda do item saleQuantity: type: number format: double description: Quantidade de venda salePrice: type: string description: Preço de venda do item grossValue: type: string description: Valor bruto do item netValue: type: string description: Valor liquido do item financialValue: type: string description: valor financeiro do item discountPercentage: type: number format: double description: Percentual de desconto do item discountValue: type: string description: Valor de desconto do item saleRepresentative: type: object allOf: – #/definitions/representative description: Representante do item comissionPercentage: type: number format: double description: Percentual de comissão do item itemAdditionalDescription: type: string description: Descrição complementar do item itemNote: type: string description: Observação do item ncm: type: object allOf: – #/definitions/ncm description: NCM do item productCESTCode: type: string description: Especificador de substituição tributária fci: type: string maxLength: 36 description: Código FCI costCenter: type: object allOf: – #/definitions/costCenter description: Centro de custo financialAccount: type: object allOf: – #/definitions/financialAccount description: Conta financeira additionalValues: type: object allOf: – #/definitions/additionalValues description: Valores adicionais do item taxes: type: array items: type: object allOf: – #/definitions/taxes description: Impostos do item batches: type: array items: type: object allOf: – #/definitions/batch description: Lotes serial: type: array items: type: object allOf: – #/definitions/serial description: Serial warehouse: type: object allOf: – #/definitions/warehouse description: Depósito _discriminator: type: string description: measureUnit: description: Informações da unidade de medida type: object properties: id: type: string description: Id da unidade de medida code: type: string description: Código da unidade de medida defaultInformation: description: Informações de busca gerais discriminator: _discriminator type: object required: – _discriminator properties: id: type: string description: Id code: type: string description: Código _discriminator: type: string description: ncm: description: Informações do NCM type: object properties: id: type: string description: Id do ncm code: type: string description: Código do ncm costCenter: description: Informações do centro de custo type: object properties: id: type: string description: Id do centro de custo code: type: string description: Código do centro de custo financialAccount: description: Informações do conta financeira type: object properties: id: type: string description: Id da conta financeira code: type: string description: Código da conta financeira batch: description: Informações dos lotes type: object required: – quantity properties: id: type: string description: Id do lote code: type: string description: Código do lote quantity: type: number format: double description: Quantidade de venda do lote serial: description: Informações do serial type: object properties: id: type: string description: Id do serial code: type: string description: Código do serial warehouse: description: type: object properties: id: type: string description: ID do depósito code: type: string description: Código do depósito taxes: description: Dados de impostos da nota type: object required: – taxType properties: taxType: type: string allOf: – #/definitions/taxType description: Tipo de imposto taxCalculationBasis: type: string description: Base de cálculo do imposto taxRate: type: number format: double description: Alíquota do imposto interstateTaxRate: type: number format: double description: Alíquota interestadual taxValue: type: string description: Valor do imposto taxReduction: type: number format: double description: Percentual de redução da base do imposto otherValue: type: string description: Valor de outras exemptedValue: type: string description: Valor de isentas productTaxOrigin: type: string allOf: – #/definitions/productTaxOrigin description: Origem fiscal da mercadoria cst: type: string description: situação tributária amountCollection: type: number format: double description: Valor recolhido pelo substituto taxClassification: type: string description: Classificação tributária additionalValues: description: Informações de valores adicionais type: object properties: additionalDiscountPercent: type: number format: double description: Percentual de desconto adicional additionalDiscountValue: type: string description: Valor de desconto adicional chargesValue: type: string description: Valor dos encargos otherExpensesValue: type: string description: Valor das outras despesas statedOtherExpensesValue: type: string description: Valor das outras despesas destacado importOtherExpensesValue: type: string description: Valor das outras despesas de importação invoiceInstallment: description: Informações de parcelas type: object required: – installmentDueDate properties: installmentIndex: type: integer format: int64 description: Sequência installmentDays: type: integer format: int64 description: Quantidade de dias para a parcela integrationType: type: string allOf: – #/definitions/integrationTypeInstallment description: Tipo de integração da parcela changeValue: type: number format: double description: Valor do troco installmentDueDate: type: string format: date description: Data de vencimento da parcela installmentPercentage: type: number format: double description: Percentual da parcela installmentValue: type: string description: Valor da parcela paymentMethodId: type: string description: Id da forma de pagamento installmentNote: type: string maxLength: 250 description: Observação da parcela cardCompanyTaxNumber: type: string maxLength: 14 description: CNPJ da credenciadora de cartão de crédito/débito cardBrand: type: string allOf: – #/definitions/cardBrand description: Bandeira da operadora de cartão de crédito/débito authorizationNumber: type: string maxLength: 100 description: Número de autorização da operação cartão de crédito/débito nsu: type: string maxLength: 100 description: Número sequencial único da transação TEF paymentMethodType: type: string allOf: – #/definitions/paymentMethodType description: Indicativo da forma de pagamento accountsReceivableGroupId: type: string description: Id do grupo a receber accountsReceivableTypeId: type: string description: Id do tipo do título bearerId: type: string description: Id do portador portfolioId: type: string description: Id da carteira expenseNatureId: type: string description: Id da natureza de gasto billNumber: type: string maxLength: 10 description: Número do título transportInformation: description: Informações de transporte type: object properties: departureDate: type: string format: date-time description: Data e hora de saída deliveryScheduleDate: type: string format: date description: Data de agendamento da entrega deliveryAddressId: type: string description: Id do endereço de entrega shippingCompany: type: object allOf: – #/definitions/person description: Id da transportadora redispatchCompany: type: object allOf: – #/definitions/person description: Id da transportadora de redespacho vehicleLicensePlate: type: string description: Placa do veículo vehicleStateId: type: string description: UF do veículo wagonIdentification: type: string description: Identificação do vagão ferryIdentification: type: string description: Identificação da balsa freightType: type: string allOf: – #/definitions/cifFob description: Tipo de frete boardingLocation: type: string description: Descrição do local de embarque boardingStateId: type: string description: UF de embarque dispatchLocation: type: string description: Descrição do local de despacho trailersInformation: type: array items: type: object allOf: – #/definitions/trailerInformation description: Reboques volumesInformation: type: array items: type: object allOf: – #/definitions/volumeInformation description: Volumes transportValues: type: object allOf: – #/definitions/transportValues description: Valores de transporte trailerInformation: description: Informações de reboque type: object properties: shippingCompanyId: type: string description: Id da transportadora do reboque trailerLicensePlate: type: string description: Placa trailerStateId: type: string description: UF volumeInformation: description: Informações de volume type: object properties: volumeQuantity: type: integer format: int64 description: Quantidade volumeType: type: string description: Espécie volumeBrand: type: string description: Marca volumeNumbering: type: string description: Numeração volumeGrossWeight: type: number format: double description: Peso bruto volumeNetWeight: type: number format: double description: Peso líquido volumeBarcode: type: string description: Código de barras transportValues: description: Informações de valores de transporte type: object properties: freightValue: type: string description: Valor do frete statedFreightValue: type: string description: Valor do frete destacado importFreightValue: type: string description: Valor do frete de importação insuranceValue: type: string description: Valor do seguro importInsuranceValue: type: string description: Valor de seguro de importação packagingValue: type: string description: Valor das embalagens additionalInformation: description: Informações adicionais type: object properties: invoiceNote: type: string description: Observação customerOrderNumber: type: string description: Número do pedido do cliente statusCauseId: type: string description: Id do motivo de situação específica statusCauseNote: type: string description: Observação do motivo consumerPresence: type: string allOf: – #/definitions/consumerPresence description: Indicativo de presença do consumidor issCollectionCityId: type: string description: Cidade de recolhimento de ISS serviceProvisionDate: type: string format: date description: Data de prestação do serviço notes: type: array items: type: object allOf: – #/definitions/invoiceNote description: Observações da nota fiscal fiscalMessagesId: type: array items: type: string description: Mensagens fiscais additionalValues: type: object allOf: – #/definitions/additionalValues description: Valores adicionais indicativeIntermediation: type: string allOf: – #/definitions/indicativeIntermediation description: Indicativo de intermediação intermediaryTaxNumber: type: string maxLength: 14 description: CNPJ do Intermediador da Transação intermediaryRegistration: type: string maxLength: 60 description: Identificador cadastrado no intermediador invoiceAdditionalInformation: type: string description: Informações complementares para documento fiscal invoiceNote: description: Informações de observação type: object properties: note: type: string description: Texto da observação statusCauseId: type: string description: Id do motivo de situação específica billingInformation: description: Informações de cobrança type: object properties: billingAddressId: type: string description: Id do endereço de cobrança paymentTermId: type: string description: Id da condição de pagamento installments: type: array items: type: object allOf: – #/definitions/invoiceInstallment description: Parcelas referencedDocument: description: Documentos referenciados type: object properties: electronicInvoiceReferenced: type: array items: type: object allOf: – #/definitions/electronicInvoiceReferenced description: Nota Fiscal Eletrônica paperInvoiceReferenced: type: array items: type: object allOf: – #/definitions/paperInvoiceReferenced description: Nota Fiscal Modelo 1/1A ou Modelo 2 producerInvoiceReferenced: type: array items: type: object allOf: – #/definitions/producerInvoiceReferenced description: Nota Fiscal do Produtor cteReferenced: type: array items: type: object allOf: – #/definitions/cteReferenced description: Conhecimento de Transporte Eletrônico taxCouponReferenced: type: array items: type: object allOf: – #/definitions/taxCouponReferenced description: Cupom fiscal reversalInvoiceReferenced: type: object allOf: – #/definitions/reversalInvoiceReferenced description: Nota Fiscal Eletrônica Estorno / Estornada electronicInvoiceReferenced: description: Documentos fiscais referenciados (NF-e) type: object properties: keyAccess: type: string maxLength: 44 description: Chave de acesso paperInvoiceReferenced: description: Documentos fiscais referenciados (Modelo 1A) type: object properties: emitentStateInitials: type: string maxLength: 2 description: Sigla da UF do emitente emissionYearMonth: type: string maxLength: 4 description: Ano e Mês de emissão da NF-e emitentCNPJ: type: string maxLength: 14 description: CNPJ do emitente invoiceModel: type: string maxLength: 2 description: Modelo do Documento Fiscal invoiceSeries: type: string maxLength: 3 description: Série do Documento Fiscal invoiceNumber: type: string maxLength: 9 description: Número do Documento Fiscal producerInvoiceReferenced: description: type: object properties: emitentStateInitials: type: string maxLength: 2 description: Sigla da UF do emitente emissionYearMonth: type: string maxLength: 4 description: Ano e Mês de emissão da NF-e emitentCNPJ: type: string maxLength: 14 description: CNPJ do emitente emitentCPF: type: string maxLength: 11 description: CPF do emitente emitentIE: type: string maxLength: 14 description: IE do emitente invoiceModel: type: string maxLength: 2 description: Modelo do Documento Fiscal invoiceSeries: type: string maxLength: 3 description: Série do Documento Fiscal invoiceNumber: type: string maxLength: 9 description: Número do Documento Fiscal cteReferenced: description: Documentos fiscais referenciados (CT-e) type: object properties: keyAccess: type: string maxLength: 44 description: Chave de acesso taxCouponReferenced: description: Documentos fiscais referenciados (Cupom fiscal) type: object properties: invoiceModel: type: string maxLength: 2 description: Modelo do Documento Fiscal sequencialECFNumber: type: string maxLength: 3 description: Número de ordem sequencial do ECF cooNumber: type: string maxLength: 6 description: Número do Contador de Ordem de Operação – COO reversalInvoiceReferenced: description: Documentos fiscais referenciados (NF-e Estorno / Estornada) type: object properties: reversalInvoiceId: type: string description: Identificador da nota de estorno / estornada keyAccess: type: string maxLength: 44 description: Chave de acesso complement: type: string maxLength: 2000 description: Complemento issueDateTime: type: string format: date-time description: Data e hora de emissão do documento referenciado invoiceSeries: type: string maxLength: 3 description: Série do Documento Fiscal invoiceNumber: type: string maxLength: 9 description: Número do Documento Fiscal eletronicInformation: description: Dados eletrônicos do documento fiscal type: object properties: accessKey: type: string maxLength: 50 description: Chave do documento eletrônico protocolNumber: type: string maxLength: 100 description: Número do protocolo de autorização do documento eletrônico authorizationDate: type: string format: date-time description: Data e hora de autorização do documento eletrônico externalInvoiceIntegration: description: Dados de integrações provenientes de sistemas externos type: object required: – integrationProcessType properties: id: type: string format: uuid description: Identificador da entidade externalId: type: string description: Id de identificação no sistema externo status: type: string allOf: – #/definitions/enumExternalInvoiceStatus description: Situação da integração errorMessage: type: string description: Mensagem de erro invoicePayload: type: string description: Payload da integração externalIntegrationType: type: string allOf: – #/definitions/enumExternalInvoiceIntegration description: Identificador da origem integração externa e140nfs: type: object allOf: – #/definitions/e140nfs description: Id da nota fiscal integrationProcessType: type: string allOf: – #/definitions/externalIntegrationProcess description: Tipo de processamento da integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: editExternalInvoiceIntegration: type: object required: – id allOf: – #/definitions/externalInvoiceIntegration e140nfs: description: Nota fiscal – Dados Gerais type: object required: – e070fil properties: id: type: string format: uuid description: Id da entidade e070fil: type: object allOf: – #/definitions/e070fil description: Filial e140inf: type: object allOf: – #/definitions/e140inf description: Informacoes Adicionais e140ide: type: object allOf: – #/definitions/e140ide description: Informação do documento eletrônico usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e140inf: description: Informações Adicionais da nota fiscal type: object properties: id: type: string format: uuid description: Id da entidade e140nfs: type: object allOf: – #/definitions/e140nfs description: Id da nota fiscal de saída externalInvoiceId: type: string description: Identificador externo da nota fiscal proveniente de integração usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e140ide: description: Informações do documento eletrônico type: object properties: id: type: string format: uuid description: Id da entidade e140nfs: type: object allOf: – #/definitions/e140nfs description: Id da nota fiscal de saída externallyAuthorized: type: boolean description: Identifica se a nota fiscal foi autorizada por sistema externo default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070fil: description: Filial type: object required: – e070emp – codFil – nomFil – sigFil properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codFil: type: integer format: int64 description: Filial minimum: 0 maximum: 9999 nomFil: type: string maxLength: 100 description: Nome sigFil: type: string maxLength: 100 description: Fantasia extIntSts: type: string description: Indica status da replicação extIntMsg: type: string description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e070emp: description: Empresa type: object required: – codEmp – nomEmp – sigEmp properties: id: type: string format: uuid description: Id da entidade codEmp: type: integer format: int64 description: Código da empresa minimum: 0 maximum: 9999 nomEmp: type: string maxLength: 100 description: Nome da empresa sigEmp: type: string maxLength: 100 description: Nome fantasia da empresa excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Indica status da replicação extIntMsg: type: string description: Indica a mensagem da replicação usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: modulos: description: Módulos adquiridos pelo cliente type: object required: – modulo – ativo properties: id: type: string format: uuid description: Identificador modulo: type: string allOf: – #/definitions/enumModulos description: Módulo empresa: type: object allOf: – #/definitions/e070emp description: Empresa ativo: type: boolean description: Indicador se o módulo está ativo integracaoDataLake: type: boolean description: Indicador se o módulo faz integração com o Data Lake usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: 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 enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage