erpx_sup

transacao (TRANSACAO)

2 views 04/08/2020 integrador 0

2.0info: 2.0.0 TRANSACAO description: ERPX x-senior-domain: ERPX_SUP x-senior-domain-path: erpx_sup x-senior-service-path: transacao contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/erpx_supsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /transacao/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 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 default: description: Error response schema: #/definitions/genericError /transacao/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: 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: default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE001tnsSupGer: 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: default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE001tnsSupEst: 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: default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE205dep: 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: default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE070emp: 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: default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE070fil: 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: default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE001tns: 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: default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE001tnsSupRcb: 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: default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE002tpt: 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: default: description: Error response schema: #/definitions/genericError /transacao/queries/exportE031moe: 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: default: description: Error response schema: #/definitions/genericError /transacao/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 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 default: description: Error response schema: #/definitions/genericError /transacao/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response default: description: Error response schema: #/definitions/genericError /transacao/actions/importE001tnsSupGer: 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: default: description: Error response schema: #/definitions/genericError /transacao/actions/importE001tnsSupEst: 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: default: description: Error response schema: #/definitions/genericError /transacao/actions/importE205dep: 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: default: description: Error response schema: #/definitions/genericError /transacao/actions/importE070emp: 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: default: description: Error response schema: #/definitions/genericError /transacao/actions/importE070fil: 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: default: description: Error response schema: #/definitions/genericError /transacao/actions/importE001tns: 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: default: description: Error response schema: #/definitions/genericError /transacao/actions/importE001tnsSupRcb: 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: default: description: Error response schema: #/definitions/genericError /transacao/actions/importE002tpt: 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: default: description: Error response schema: #/definitions/genericError /transacao/actions/importE031moe: 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: default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsSupGer: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e001tnsSupGer responses: 200: description: The created resource schema: #/definitions/e001tnsSupGer default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e001tnsSupGer responses: 200: description: The created resource schema: #/definitions/e001tnsSupGer default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/e001tnsSupGer default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsSupGer/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e001tnsSupGer responses: 200: description: Ok schema: #/definitions/e001tnsSupGer default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e001tnsSupGer responses: 200: description: Ok schema: #/definitions/e001tnsSupGer default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e001tnsSupGer default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsSupGer/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e001tnsSupGer responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsSupEst: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e001tnsSupEst responses: 200: description: The created resource schema: #/definitions/e001tnsSupEst default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e001tnsSupEst responses: 200: description: The created resource schema: #/definitions/e001tnsSupEst default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/e001tnsSupEst default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsSupEst/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e001tnsSupEst responses: 200: description: Ok schema: #/definitions/e001tnsSupEst default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e001tnsSupEst responses: 200: description: Ok schema: #/definitions/e001tnsSupEst default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e001tnsSupEst default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsSupEst/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e001tnsSupEst responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /transacao/entities/e205dep: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e205dep responses: 200: description: The created resource schema: #/definitions/e205dep default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e205dep responses: 200: description: The created resource schema: #/definitions/e205dep default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/e205dep default: description: Error response schema: #/definitions/genericError /transacao/entities/e205dep/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e205dep responses: 200: description: Ok schema: #/definitions/e205dep default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e205dep responses: 200: description: Ok schema: #/definitions/e205dep default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e205dep default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /transacao/entities/e205dep/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e205dep responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /transacao/entities/e070emp: get: description: This entity is customizable. 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/e070emp default: description: Error response schema: #/definitions/genericError /transacao/entities/e070emp/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070emp default: description: Error response schema: #/definitions/genericError /transacao/entities/e070fil: get: description: This entity is customizable. 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/e070fil default: description: Error response schema: #/definitions/genericError /transacao/entities/e070fil/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e070fil default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tns: get: description: This entity is customizable. 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/e001tns default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tns/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e001tns default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsSupRcb: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e001tnsSupRcb responses: 200: description: The created resource schema: #/definitions/e001tnsSupRcb default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/e001tnsSupRcb responses: 200: description: The created resource schema: #/definitions/e001tnsSupRcb default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. 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/e001tnsSupRcb default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsSupRcb/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e001tnsSupRcb responses: 200: description: Ok schema: #/definitions/e001tnsSupRcb default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/e001tnsSupRcb responses: 200: description: Ok schema: #/definitions/e001tnsSupRcb default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e001tnsSupRcb default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /transacao/entities/e001tnsSupRcb/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/e001tnsSupRcb responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /transacao/entities/e002tpt: get: description: This entity is customizable. 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/e002tpt default: description: Error response schema: #/definitions/genericError /transacao/entities/e002tpt/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e002tpt default: description: Error response schema: #/definitions/genericError /transacao/entities/e031moe: get: description: This entity is customizable. 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/e031moe default: description: Error response schema: #/definitions/genericError /transacao/entities/e031moe/{id}: get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/e031moe default: description: Error response schema: #/definitions/genericError definitions: upDown: description: Up or down type: string enum: – UP – DOWN enumAplGrp: description: Tipo de aplicação type: string enum: – VA – VR – VP enumEntSai: description: Indicativo se a transação é de entrada ou saída type: string enum: – VE – VS enumLisMod: description: Módulo da transação type: string enum: – VVEP – VVEF – VVES – VESN – VESR – VESB – VCRE – VCRP – VCRB – VCOO – VCOF – VCOS – VCPE – VCPP – VCPB – VCPM – VCBC – VCBM – VPAT enumSitReg: description: Situação do registro type: string enum: – VA – VI enumEstMov: description: Tipo do estoque movimentado pela transação type: string enum: – VNO – VNR – VNB – VRE – VBL – VCC – VCF – VET – VPT – VCO – VCQ enumVlrEst: description: Forma de valorização dos movimentos dos estoques de produtos type: string enum: – VM – VF enumEstCam: description: Indicativo de onde será acumulada a quantidade do movimento de estoque na rotina de acúmulos mensais type: string enum: – VE – VC – VD – VN enumOriVmo: description: Origem do valor do movimento de estoque nas notas de devoluções, retornos e transferências type: string enum: – V1 – V2 – V3 enumTipRgr: description: Tipo de recebimento type: string enum: – V0 – V1 – V2 – V3 enumOpeCpr: description: Tipo da operação de compra type: string enum: – VP – VR – VN enumEstNft: description: Indica qual deve ser o estado após a geração da nota fiscal por transferência type: string enum: – V0 – V1 – V2 enumTipDep: description: Enumeração do tipo de deposito e localização type: string enum: – V1 – V2 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 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 e001tnsSupGer: description: Transações Suprimentos Geral type: object properties: id: type: string format: uuid description: Id da entidade e001tns: type: object allOf: – #/definitions/e001tns description: Transação cprUoc: type: boolean description: Transação atualiza históricos das últimas compras gerPed: type: boolean description: Indicativo se gera pedido para o item no fechamento da nota fiscal de entrada ou ordem de compra obrFxt: type: boolean description: Indicativo se é obrigatória a ligação família/produto/serviço X transação obrFxf: type: boolean description: Indicativo se é obrigatória a ligação Família/Produto/Serviço X Fornecedor excluido: type: boolean description: Indica se o registro foi excluído e002tptCprTpt: type: object allOf: – #/definitions/e002tpt description: Tipo de título gerado no contas a pagar pela transação NF de entrada e031moeCprMoe: type: object allOf: – #/definitions/e031moe description: Código moeda padrão para os títulos gerados no contas a pagar cprTnf: type: boolean description: Transação soma o valor do item no valor total do financeiro default: false usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e001tnsSupEst: description: Transações Suprimentos Estoque type: object required: – estEos – estMov – depTns – estPrr properties: id: type: string format: uuid description: Id da entidade e001tns: type: object allOf: – #/definitions/e001tns description: Transação e205depEstDep: type: object allOf: – #/definitions/e205dep description: Código do depósito padrão para movimentação dos estoques e001tnsEstTrf: type: object allOf: – #/definitions/e001tns description: Transação correspondente de transferência de estoques estEos: type: string allOf: – #/definitions/enumEntSai description: Indicativo se a transação é de entrada ou saída estMov: type: string allOf: – #/definitions/enumEstMov description: Tipo do estoque movimentado pela transação estVmv: type: string allOf: – #/definitions/enumVlrEst description: Forma de valorização dos movimentos dos estoques de produtos estCam: type: string allOf: – #/definitions/enumEstCam description: Indicativo de onde será acumulada a quantidade do movimento de estoque na rotina de acúmulos mensais estPru: type: boolean description: Indicativo se a transação atualiza preço da última entrada oriVmo: type: string allOf: – #/definitions/enumOriVmo description: Origem do valor do movimento de estoque nas notas de devoluções, retornos e transferências estCqm: type: boolean description: Indicativo se deve ser considerada a quantidade ao fazer o movimento de estoque (Somente quando valorizados pelo movimento) default: true cprCve: type: boolean description: Indicativo se o item da nota fiscal de entrada deve ser considerado ao fazer a valorização dos estoques pelo conhecimento de frete estEsv: type: boolean description: Indicativo se a transação de entrada do tipo M aceitará movimentos sem valor depTns: type: boolean description: Obrigar Depósito X Transação estCon: type: boolean description: Indicativo de considera como consumo estCoc: type: boolean description: Indicativo se a transação movimenta estoques consignados a clientes estCof: type: boolean description: Indicativo se a transação movimenta estoques consignados de fornecedores estPrr: type: boolean description: Indicativo se a transação atualiza preço de reposição prcVlr: type: boolean description: Indicativo se a transação deve computar o valor médio e001tnsTnsSre: type: object allOf: – #/definitions/e001tns description: Transação para saída de reserva e001tnsTnsTer: type: object allOf: – #/definitions/e001tns description: Transação para controlar estoque de terceiro e001tnsTnsEpt: type: object allOf: – #/definitions/e001tns description: Transação para movimentar estoque em poder de terceiros e001tnsTnsRbe: type: object allOf: – #/definitions/e001tns description: Transação para reserva/bloqueio de entrada e001tnsEstorno: type: object allOf: – #/definitions/e001tnsSupEst description: Transação para estorno da movimentação estorno: type: boolean description: Indica se o registro é usado apenas para estorno default: false excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e205dep: description: Depósito type: object required: – e070emp – e070fil – codDep – desDep – abrDep – sitDep properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa e070fil: type: object allOf: – #/definitions/e070fil description: Filial Localização codDep: type: string maxLength: 10 description: Depósito desDep: type: string maxLength: 30 description: Descrição abrDep: type: string maxLength: 10 description: Abreviatura sitDep: type: string allOf: – #/definitions/enumSitReg description: Situação tipDep: type: string allOf: – #/definitions/enumTipDep description: Tipo readOnly: true excluido: type: boolean description: Indica se o registro foi exclusão default: false 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 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: 10 description: Nome fantasia da empresa extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração excluido: type: boolean description: Indica se o registro foi excluído 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 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: 99999 nomFil: type: string maxLength: 100 description: Nome sigFil: type: string maxLength: 30 description: Nome Fantasia da Filial da Empresa numCgc: type: string maxLength: 18 description: Número do CPNJ/CPF da Filial da Empresa extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e001tns: description: Transação type: object properties: id: type: string format: uuid description: Id da entidade e070emp: type: object allOf: – #/definitions/e070emp description: Empresa codTns: type: string maxLength: 5 description: Transação desTns: type: string maxLength: 60 description: Descrição lisMod: type: string allOf: – #/definitions/enumLisMod description: Módulo detTns: type: string maxLength: 599 description: Detalhamento aceMan: type: boolean description: Aceita movimentação manuais sitTns: type: string allOf: – #/definitions/enumSitReg description: Situação e001tnsSupGer: type: object allOf: – #/definitions/e001tnsSupGer description: Especialização transações suprimentos geral e001tnsSupEst: type: object allOf: – #/definitions/e001tnsSupEst description: Especialização transações suprimentos estoque e001tnsSupRcb: type: object allOf: – #/definitions/e001tnsSupRcb description: Especialização da transação suprimentos recebimento extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado da integração excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e001tnsSupRcb: description: Especialização da transação suprimentos recebimento type: object required: – cprAoc – cprCtr – tipRgr – opeCpr – obrCps – tnsBnf – indRci – estNft properties: id: type: string format: uuid description: Id da entidade e001tns: type: object allOf: – #/definitions/e001tns description: Transação cprAoc: type: boolean description: Transação nota fiscal de entrada exige ordem de compra cprDev: type: boolean description: Transação é de nota fiscal de entrada de devolução cprHen: type: boolean description: Transação atualiza históricos das entradas de notas fiscais cprCtr: type: boolean description: Transação nota fiscal de entrada exige contrato tipRgr: type: string allOf: – #/definitions/enumTipRgr description: Tipo de recebimento opeCpr: type: string allOf: – #/definitions/enumOpeCpr description: Tipo da operação de compra obrCps: type: boolean description: Indicativo se é obrigatório informar o código de produto/serviço nas NFE reaPed: type: boolean description: Indicativo se a transação reabilita o pedido vinculado a nota fiscal de saída utilizada como origem temCnt: type: boolean description: Indica se a nota necessita ou não de conferência gerCnt: type: boolean description: Indicativo se deve gerar conferência automática no momento do fechamento da NF Entrada (Somente se necessita conferência) tnsBnf: type: boolean description: Indicativo se a transação é utilizada para movimentos de entrada de bonificação indRci: type: boolean description: Indicativo se a transação permite retorno de componentes industrializados estNft: type: string allOf: – #/definitions/enumEstNft description: Indica qual deve ser o estado após a geração da nota fiscal por transferência excluido: type: boolean description: Indica se o registro foi excluído usuger: type: string description: dthger: type: string format: date-time description: usualt: type: string description: dthalt: type: string format: date-time description: e002tpt: description: Tipo de título type: object properties: id: type: string format: uuid description: Id da entidade codTpt: type: string maxLength: 3 description: Código desTpt: type: string maxLength: 40 description: Descrição sitTpt: type: string allOf: – #/definitions/enumSitReg description: Situação aplTpt: type: string allOf: – #/definitions/enumAplGrp description: Tipo de aplicação excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado 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: e031moe: description: Moeda type: object properties: id: type: string format: uuid description: Id da entidade codMoe: type: string maxLength: 3 description: Código desMoe: type: string maxLength: 30 description: Descrição sigMoe: type: string maxLength: 5 description: Sigla excluido: type: boolean description: Indica se o registro foi excluído default: false extIntSts: type: string description: Estado de integração com a entidade externa extIntMsg: type: string description: Mensagem do resultado 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: 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

Este artigo foi útil para você?

Leave A Comment