Core (core)

2.0info: 2.9.1 Core description: Serviço responsável pela criação de recursos e disparo de eventos na platform. x-senior-domain: CRM x-senior-domain-path: crm x-senior-service-path: core 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/crmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /core/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 /core/queries/exportAccount: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportAccountDefinition: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportAccountPhone: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportAccountAddress: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportActivityBranches: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportCompanyGroups: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportPriceTable: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportCarrier: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportPaymentTerms: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportOpportunityType: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportPaymentType: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportDeposit: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportProduct: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportService: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportOpportunity: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportOpportunityProposal: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportOpportunityProduct: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/queries/exportOpportunityService: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/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 /core/actions/importAccount: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importAccountDefinition: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importAccountPhone: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importAccountAddress: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importActivityBranches: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importCompanyGroups: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importPriceTable: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importCarrier: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importPaymentTerms: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importOpportunityType: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importPaymentType: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importDeposit: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importProduct: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importService: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importOpportunity: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importOpportunityProposal: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importOpportunityProduct: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/actions/importOpportunityService: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/events/importAccountEvent: 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 /core/events/exportAccountEvent: 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 /core/events/importAccountDefinitionEvent: 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 /core/events/exportAccountDefinitionEvent: 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 /core/events/importAccountPhoneEvent: 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 /core/events/exportAccountPhoneEvent: 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 /core/events/importAccountAddressEvent: 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 /core/events/exportAccountAddressEvent: 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 /core/events/importActivityBranchesEvent: 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 /core/events/exportActivityBranchesEvent: 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 /core/events/importCompanyGroupsEvent: 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 /core/events/exportCompanyGroupsEvent: 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 /core/events/importPriceTableEvent: 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 /core/events/exportPriceTableEvent: 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 /core/events/importCarrierEvent: 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 /core/events/exportCarrierEvent: 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 /core/events/importPaymentTermsEvent: 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 /core/events/exportPaymentTermsEvent: 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 /core/events/importOpportunityTypeEvent: 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 /core/events/exportOpportunityTypeEvent: 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 /core/events/importPaymentTypeEvent: 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 /core/events/exportPaymentTypeEvent: 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 /core/events/importDepositEvent: 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 /core/events/exportDepositEvent: 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 /core/events/importProductEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /core/events/exportProductEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /core/events/importServiceEvent: 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 /core/events/exportServiceEvent: 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 /core/events/importOpportunityEvent: 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 /core/events/exportOpportunityEvent: 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 /core/events/importOpportunityProposalEvent: 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 /core/events/exportOpportunityProposalEvent: 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 /core/events/importOpportunityProductEvent: 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 /core/events/exportOpportunityProductEvent: 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 /core/events/importOpportunityServiceEvent: 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 /core/events/exportOpportunityServiceEvent: 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 /core/entities/account: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/account responses: 200: description: The created resource schema: #/definitions/account 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/account responses: 200: description: The created resource schema: #/definitions/account 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/account 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/account/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/account responses: 200: description: Ok schema: #/definitions/account 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/account responses: 200: description: Ok schema: #/definitions/account 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/account 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/account/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/account responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/accountDefinition: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountDefinition responses: 200: description: The created resource schema: #/definitions/accountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountDefinition responses: 200: description: The created resource schema: #/definitions/accountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/accountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/accountDefinition/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountDefinition responses: 200: description: Ok schema: #/definitions/accountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountDefinition responses: 200: description: Ok schema: #/definitions/accountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountDefinition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/accountDefinition/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountDefinition responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/accountPhone: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountPhone responses: 200: description: The created resource schema: #/definitions/accountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountPhone responses: 200: description: The created resource schema: #/definitions/accountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/accountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/accountPhone/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountPhone responses: 200: description: Ok schema: #/definitions/accountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountPhone responses: 200: description: Ok schema: #/definitions/accountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountPhone 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/accountPhone/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountPhone responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/accountAddress: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountAddress responses: 200: description: The created resource schema: #/definitions/accountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/accountAddress responses: 200: description: The created resource schema: #/definitions/accountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/accountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/accountAddress/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountAddress responses: 200: description: Ok schema: #/definitions/accountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/accountAddress responses: 200: description: Ok schema: #/definitions/accountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountAddress 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/accountAddress/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountAddress responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/activityBranches: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/activityBranches responses: 200: description: The created resource schema: #/definitions/activityBranches 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/activityBranches responses: 200: description: The created resource schema: #/definitions/activityBranches 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/activityBranches 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/activityBranches/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/activityBranches responses: 200: description: Ok schema: #/definitions/activityBranches 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/activityBranches responses: 200: description: Ok schema: #/definitions/activityBranches 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/activityBranches 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/activityBranches/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/activityBranches responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/companyGroups: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyGroups responses: 200: description: The created resource schema: #/definitions/companyGroups 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/companyGroups responses: 200: description: The created resource schema: #/definitions/companyGroups 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/companyGroups 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/companyGroups/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companyGroups responses: 200: description: Ok schema: #/definitions/companyGroups 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/companyGroups responses: 200: description: Ok schema: #/definitions/companyGroups 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/companyGroups 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/companyGroups/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/companyGroups responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/priceTable: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/priceTable responses: 200: description: The created resource schema: #/definitions/priceTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/priceTable responses: 200: description: The created resource schema: #/definitions/priceTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/priceTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/priceTable/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/priceTable responses: 200: description: Ok schema: #/definitions/priceTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/priceTable responses: 200: description: Ok schema: #/definitions/priceTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/priceTable 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/priceTable/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/priceTable responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/carrier: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/carrier responses: 200: description: The created resource schema: #/definitions/carrier 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/carrier responses: 200: description: The created resource schema: #/definitions/carrier 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/carrier 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/carrier/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/carrier responses: 200: description: Ok schema: #/definitions/carrier 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/carrier responses: 200: description: Ok schema: #/definitions/carrier 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/carrier 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/carrier/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/carrier responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/paymentTerms: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/paymentTerms responses: 200: description: The created resource schema: #/definitions/paymentTerms 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/paymentTerms responses: 200: description: The created resource schema: #/definitions/paymentTerms 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/paymentTerms 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/paymentTerms/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paymentTerms responses: 200: description: Ok schema: #/definitions/paymentTerms 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paymentTerms responses: 200: description: Ok schema: #/definitions/paymentTerms 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/paymentTerms 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/paymentTerms/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/paymentTerms responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/opportunityType: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/opportunityType responses: 200: description: The created resource schema: #/definitions/opportunityType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/opportunityType responses: 200: description: The created resource schema: #/definitions/opportunityType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/opportunityType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/opportunityType/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityType responses: 200: description: Ok schema: #/definitions/opportunityType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityType responses: 200: description: Ok schema: #/definitions/opportunityType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/opportunityType/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/opportunityType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/paymentType: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/paymentType responses: 200: description: The created resource schema: #/definitions/paymentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/paymentType responses: 200: description: The created resource schema: #/definitions/paymentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/paymentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/paymentType/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paymentType responses: 200: description: Ok schema: #/definitions/paymentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paymentType responses: 200: description: Ok schema: #/definitions/paymentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/paymentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/paymentType/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/paymentType responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/deposit: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deposit responses: 200: description: The created resource schema: #/definitions/deposit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/deposit responses: 200: description: The created resource schema: #/definitions/deposit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/deposit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/deposit/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/deposit responses: 200: description: Ok schema: #/definitions/deposit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/deposit responses: 200: description: Ok schema: #/definitions/deposit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/deposit 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/deposit/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/deposit responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/product: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/product responses: 200: description: The created resource schema: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/product responses: 200: description: The created resource schema: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/product/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/product responses: 200: description: Ok schema: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/product responses: 200: description: Ok schema: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/product 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/product/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/product responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/service: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/service responses: 200: description: The created resource schema: #/definitions/service 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/service responses: 200: description: The created resource schema: #/definitions/service 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/service 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/service/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/service responses: 200: description: Ok schema: #/definitions/service 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/service responses: 200: description: Ok schema: #/definitions/service 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/service 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/service/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/service responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/opportunity: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/opportunity responses: 200: description: The created resource schema: #/definitions/opportunity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/opportunity responses: 200: description: The created resource schema: #/definitions/opportunity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/opportunity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/opportunity/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunity responses: 200: description: Ok schema: #/definitions/opportunity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunity responses: 200: description: Ok schema: #/definitions/opportunity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunity 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/opportunity/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/opportunity responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/opportunityProposal: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/opportunityProposal responses: 200: description: The created resource schema: #/definitions/opportunityProposal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/opportunityProposal responses: 200: description: The created resource schema: #/definitions/opportunityProposal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/opportunityProposal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/opportunityProposal/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityProposal responses: 200: description: Ok schema: #/definitions/opportunityProposal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityProposal responses: 200: description: Ok schema: #/definitions/opportunityProposal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityProposal 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/opportunityProposal/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/opportunityProposal responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/opportunityProduct: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/opportunityProduct responses: 200: description: The created resource schema: #/definitions/opportunityProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/opportunityProduct responses: 200: description: The created resource schema: #/definitions/opportunityProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/opportunityProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/opportunityProduct/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityProduct responses: 200: description: Ok schema: #/definitions/opportunityProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityProduct responses: 200: description: Ok schema: #/definitions/opportunityProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityProduct 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/opportunityProduct/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/opportunityProduct responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/opportunityService: post: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/opportunityService responses: 200: description: The created resource schema: #/definitions/opportunityService 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/opportunityService responses: 200: description: The created resource schema: #/definitions/opportunityService 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/opportunityService 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/opportunityService/{id}: put: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityService responses: 200: description: Ok schema: #/definitions/opportunityService 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/opportunityService responses: 200: description: Ok schema: #/definitions/opportunityService 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/opportunityService 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PUBLIC parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /core/entities/opportunityService/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/opportunityService responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: 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 recordFullAccountDefinition: description: Definição da conta type: object required: – accountType – rating – status properties: id: type: integer format: int64 description: Código de identificação salesGoal: type: number format: double description: Previsão de meta de vendas para o cliente maximum: 9999999999.99 note: type: string maxLength: 80 description: Observações receiveEmail: type: boolean description: Recebe emails do sistema receiveSurvey: type: boolean description: Recebe pesquisas do sistema receiveTrackEmail: type: boolean description: Recebe e monitora emails do sistema clientSince: type: string format: date description: Data de quando a conta virou cliente customFields: type: string description: Campos customizados companyBranch: type: object allOf: – #/definitions/recordCompanyBranch description: Empresa/filial accountType: type: object allOf: – #/definitions/recordAccountType description: Tipo de conta rating: type: object allOf: – #/definitions/recordRating description: Rating da conta status: type: object allOf: – #/definitions/recordStatus description: Status inactivationReason: type: object allOf: – #/definitions/recordInactivationReason description: Motivo da inativação priceTable: type: object allOf: – #/definitions/recordPriceTable description: Tabela de preço carrier: type: object allOf: – #/definitions/recordCarrier description: Transportadora padrão carrierDispatch: type: object allOf: – #/definitions/recordCarrierDispatch description: Transportadore de redespacho padrão representative: type: object allOf: – #/definitions/recordRepresentative description: Representante padrão seller: type: object allOf: – #/definitions/recordSeller description: Vendedor padrão paymentTerm: type: object allOf: – #/definitions/recordPaymentTerm description: Prazo de pagamento padrão recordActivityBranch: description: Ramo de atividade type: object required: – id properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string description: Nome da Empresa/Filial recordCompanySize: description: Porte da empresa type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome do porte da empresa recordPersonType: description: Tipo de pessoa type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome do tipo de Pessoa recordCompanyGroup: description: Grupo de empresa type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome grupo da empresa recordOrigin: description: Origem da conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome da origem recordBasicAccount: description: Dados básicos da conta type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string description: Nome da conta cnpj: type: string maxLength: 14 description: CNPJ da Conta cpf: type: string maxLength: 11 description: CPF da Conta rg: type: string maxLength: 15 description: RG da Conta recordCompanyBranch: description: Empresa filial da definição da conta type: object required: – id – company – branch properties: id: type: integer format: int64 description: Código de identificação no CRM company: type: object allOf: – #/definitions/recordCompany description: Objeto da Empresa branch: type: object allOf: – #/definitions/recordBranch description: Objeto da filial da Empresa recordCompany: description: Objeto referente a Empresa type: object properties: id: type: integer format: int64 description: Id de identificação no CRM idErp: type: string maxLength: 50 description: Id de identificação no sistema terceiro name: type: string maxLength: 50 description: Nome da Empresa fantasyName: type: string maxLength: 50 description: Nome fantasia da Empresa recordBranch: description: Objeto referente a filial da Empresa type: object properties: id: type: integer format: int64 description: Id de identificação no CRM idErp: type: string maxLength: 50 description: Id de identificação no sistema terceiro name: type: string maxLength: 50 description: Nome da Empresa fantasyName: type: string maxLength: 50 description: Nome fantasia da Empresa recordAccountType: description: Tipo de conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome do tipo da Conta recordRating: description: Rating da conta por definição type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome da Avaliação recordStatus: description: Status da definição da conta type: object required: – id – name properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome do status recordInactivationReason: description: Motivo da inativação da definição da conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Motivo da inativação recordPriceTable: description: Tabela de preço padrão para a definição de conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string description: Nome da tabela de preços recordCarrier: description: Transportadora padrão para a definição de conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string description: Nome da operadora recordCarrierDispatch: description: Transportadore de redespacho padrão para a definição de conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string description: Nome da operadora de dispacho recordRepresentative: description: Representante padrão para a definição de conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string description: Nome do representante recordSeller: description: Vendedor padrão para a definição de conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string description: Nome do vendedor recordPaymentTerm: description: Prazo de pagamento padrão para a definição de conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string description: Nome do termo de pagamento recordAccountResponsible: description: Responsável da conta type: object required: – id properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro recordAddressType: description: Tipo de endereço type: object required: – id – name properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome recordCountry: description: Pais type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome recordState: description: Estado type: object required: – id properties: id: type: integer format: int64 description: Código de identificação name: type: string description: Nome initials: type: string description: Inicial country: type: object allOf: – #/definitions/recordCountry description: País recordCity: description: Cidade type: object required: – name properties: id: type: integer format: int64 description: Código de identificação ibgeCode: type: string maxLength: 7 description: Código da cidade no IBGE name: type: string maxLength: 50 description: Nome da cidade state: type: object allOf: – #/definitions/recordState description: Estado recordProductCategory: description: Categorias do produto type: object properties: id: type: integer format: int64 description: Código de identificação da categoria de produto no CRM idErp: type: string maxLength: 50 description: Código de identificação da categoria de produto no sistema terceiro recordUnitMeasurement: description: Unidade de medida type: object properties: id: type: integer format: int64 description: Código de identificação da unidade de medida no CRM acronym: type: string maxLength: 3 description: Sigla que identifica a unidade de medida recordServiceCategory: description: Categoria de serviço type: object properties: id: type: integer format: int64 description: Código de identificação da categoria de produto no CRM idErp: type: string maxLength: 50 description: Código de identificação da categoria de produto no sistema terceiro recordAccount: description: Conta type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro recordContact: description: Contato type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro recordOpportunityType: description: Tipo da oportunidade type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro recordOpportunitySubtype: description: Subtipo da oportunidade type: object properties: id: type: integer format: int64 description: Código de identificação no CRM recordBusinessType: description: Modalidade de negócio type: object properties: id: type: integer format: int64 description: Código de identificação no CRM recordOpportunityOrigin: description: Origem da oportunidade type: object properties: id: type: integer format: int64 description: Código de identificação no CRM recordResponsible: description: Responsável type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro recordNegotiationStage: description: Estágio de negociação type: object properties: stage: type: integer format: int64 description: Estágio minimum: 1 maximum: 6 recordLossReason: description: Motivo da perda type: object properties: id: type: integer format: int64 description: Código de identificação no CRM recordSalesReasons: description: Motivo da venda type: object properties: id: type: integer format: int64 description: Código de identificação no CRM recordOpportunity: description: Oportunidade type: object properties: id: type: integer format: int64 description: Código de identificação no CRM proposalNumber: type: string maxLength: 20 description: Número da proposta no CRM orderNumber: type: string maxLength: 20 description: Número do pedido no sistema terceiro recordTemplate: description: Template de relatório da proposta type: object properties: id: type: integer format: int64 description: Código de identificação no CRM recordIssuer: description: Emissor/criador da proposta type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro recordProposal: description: Proposta type: object properties: id: type: integer format: int64 description: Código de identificação no CRM proposalNumber: type: string maxLength: 20 description: Número da proposta no CRM orderNumber: type: string maxLength: 20 description: Número do pedido no sistema terceiro recordProduct: description: Produto type: object required: – productDerivationCode properties: id: type: integer format: int64 description: Código de identificação no CRM productCode: type: string maxLength: 45 description: Código de identificação no sistema terceiro productDerivationCode: type: string maxLength: 45 description: Código de identificação da derivação no sistema terceiro recordDeposit: description: Depósito type: object properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro recordService: description: Serviço type: object properties: id: type: integer format: int64 description: Código de identificação no CRM serviceCode: type: string maxLength: 45 description: Código de identificação no sistema terceiro account: description: Entidade fachada de criação e atualização de conta type: object required: – id – name – registerDate – active – origin – token properties: id: type: integer format: int64 description: Código de identificação idErp: type: string maxLength: 50 description: Código de identificação name: type: string maxLength: 80 description: Nome da conta fantasyName: type: string maxLength: 80 description: Nome fantasia cnpj: type: string maxLength: 14 description: CNPJ da conta cpf: type: string maxLength: 11 description: CPF da conta rg: type: string maxLength: 15 description: RG da conta stateRegistration: type: string maxLength: 15 description: Inscrição estadual municipalRegistration: type: string maxLength: 15 description: Inscrição municipal url: type: string maxLength: 80 description: URL do site da conta generalEmail: type: string maxLength: 255 description: E-mail geral financialEmail: type: string maxLength: 255 description: E-mail financeiro registerDate: type: string format: date description: Data do cadastro annualIncome: type: number format: double description: Receita anual maximum: 9999999999999999.99 employees: type: integer format: int64 description: Quantidade de funcionários einNumber: type: string maxLength: 10 description: EIN ssnNumber: type: string maxLength: 12 description: SSN birthDate: type: string format: date description: Data de nascimento/abertura active: type: boolean description: Status de atividade customFields: type: string description: Campos customizados activityBranch: type: object allOf: – #/definitions/recordActivityBranch description: Ramo de atividade companySize: type: object allOf: – #/definitions/recordCompanySize description: Porte da empresa personType: type: object allOf: – #/definitions/recordPersonType description: Tipo de poessoa companyGroup: type: object allOf: – #/definitions/recordCompanyGroup description: Grupo de empresa origin: type: object allOf: – #/definitions/recordOrigin description: Origem accountDefinition: type: object allOf: – #/definitions/recordFullAccountDefinition description: Definição da conta accountResponsible: type: object allOf: – #/definitions/recordAccountResponsible description: Responsável da conta token: type: string description: Token identificação do CRM accountDefinition: description: Entidade fachada de criação e atualização de definição de conta type: object required: – account – accountType – rating – status – token properties: id: type: integer format: int64 description: Código de identificação salesGoal: type: number format: double description: Previsão de meta de vendas para o cliente maximum: 9999999999.99 note: type: string maxLength: 80 description: Observações receiveEmail: type: boolean description: Recebe emails do sistema receiveSurvey: type: boolean description: Recebe pesquisas do sistema receiveTrackEmail: type: boolean description: Recebe e monitora emails do sistema clientSince: type: string format: date description: Data de quando a conta virou cliente customFields: type: string description: Campos customizados account: type: object allOf: – #/definitions/recordBasicAccount description: Conta dessa definição companyBranch: type: object allOf: – #/definitions/recordCompanyBranch description: Empresa/filial accountType: type: object allOf: – #/definitions/recordAccountType description: Tipo de conta rating: type: object allOf: – #/definitions/recordRating description: Rating da conta status: type: object allOf: – #/definitions/recordStatus description: Status inactivationReason: type: object allOf: – #/definitions/recordInactivationReason description: Motivo da inativação priceTable: type: object allOf: – #/definitions/recordPriceTable description: Tabela de preço carrier: type: object allOf: – #/definitions/recordCarrier description: Transportadora padrão carrierDispatch: type: object allOf: – #/definitions/recordCarrierDispatch description: Transportadore de redespacho padrão representative: type: object allOf: – #/definitions/recordRepresentative description: Representante padrão seller: type: object allOf: – #/definitions/recordSeller description: Vendedor padrão paymentTerm: type: object allOf: – #/definitions/recordPaymentTerm description: Prazo de pagamento padrão token: type: string description: Token de identificação do CRM accountPhone: description: Entidade fachada de criação e atualização de telefone da conta type: object required: – id – account – number – type – main – token properties: id: type: integer format: int64 description: Código de dentificação account: type: object allOf: – #/definitions/recordBasicAccount description: Conta do telefone number: type: string description: Número de telefone type: type: integer format: int64 description: Tipo de telefone operator: type: integer format: int64 description: Operadora da conta main: type: boolean description: Telefone principal token: type: string description: Token de identificação do CRM accountAddress: description: Entidade fachada de criação e atualização de endereço da conta type: object required: – id – account – type – main – address – active – city – token properties: id: type: integer format: int64 description: Código de identificação account: type: object allOf: – #/definitions/recordBasicAccount description: Conta do endereço type: type: object allOf: – #/definitions/recordAddressType description: Tipo de endereço main: type: boolean description: Endereço principal address: type: string maxLength: 80 description: Endereço active: type: boolean description: Status de atividade number: type: string description: Número complement: type: string maxLength: 50 description: Complemento district: type: string maxLength: 50 description: Bairro cepCode: type: string maxLength: 9 description: CEP latitude: type: string description: Latitude longitude: type: string description: Longitude city: type: object allOf: – #/definitions/recordCity description: Cidade zipCode: type: string maxLength: 16 description: ZIP code customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM activityBranches: description: Entidade fachada de ramo de atividade type: object required: – token properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do ramo de atividade active: type: boolean description: Indicador se o ramo de atividade está ativo no sistema default: true customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM companyGroups: description: Entidade fachada de grupo de empresa type: object required: – token properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa company: type: object allOf: – #/definitions/recordCompany description: Empresa active: type: boolean description: Indicador se o ramo de atividade está ativo no sistema default: true customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM priceTable: description: Entidade fachada de tabela de preço type: object required: – token properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa companyBranch: type: object allOf: – #/definitions/recordCompanyBranch description: Empresa/filial active: type: boolean description: Indicador se a tabela de preço está ativa no sistema default: true customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM carrier: description: Entidade fachada de transportadora type: object required: – token properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa companyBranch: type: object allOf: – #/definitions/recordCompanyBranch description: Empresa/filial active: type: boolean description: Indicador se a transportadora está ativa no sistema default: true customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM paymentTerms: description: Entidade fachada de prazo de pagamento type: object required: – token properties: id: type: integer format: int64 description: Código de identificação no CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa company: type: object allOf: – #/definitions/recordCompany description: Empresa active: type: boolean description: Indicador se o prazo de pagamento está ativo no sistema default: true customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM opportunityType: description: Entidade fachada de tipo de oportunidade type: object required: – token properties: id: type: integer format: int64 description: Código de identificação do CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa companyBranch: type: object allOf: – #/definitions/recordCompanyBranch description: Empresa/filial active: type: boolean description: Indicador se o tipo de oportunidade está ativo no sistema default: true note: type: string description: Observações customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM paymentType: description: Entidade fachada de tipo de pagamento type: object required: – token properties: id: type: integer format: int64 description: Código de identificação do CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa companyBranch: type: object allOf: – #/definitions/recordCompanyBranch description: Empresa/filial active: type: boolean description: Indicador se o tipo de pagamento está ativo no sistema default: true customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM deposit: description: Entidade fachada de depósito type: object required: – token properties: id: type: integer format: int64 description: Código de identificação do CRM idErp: type: string maxLength: 50 description: Código de identificação no sistema terceiro name: type: string maxLength: 50 description: Descritivo do grupo de empresa companyBranch: type: object allOf: – #/definitions/recordCompanyBranch description: Empresa/filial active: type: boolean description: Indicador se a tabela de preço está ativa no sistema default: true customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM product: description: Entidade fachada de Produto type: object required: – token properties: id: type: integer format: int64 description: Código de identificação do CRM company: type: object allOf: – #/definitions/recordCompany description: Empresa name: type: string maxLength: 50 description: Descritivo do grupo de empresa partNumber: type: string maxLength: 45 description: Identificador do produto no sistema terceiro derivationPartNumber: type: string maxLength: 45 description: Identificador da derivação do produto no sistema terceiro derivationName: type: string maxLength: 100 description: Descritivo da derivação do produto productCategory: type: object allOf: – #/definitions/recordProductCategory description: Categoria do produto unitMeasurement: type: object allOf: – #/definitions/recordUnitMeasurement description: Unidade de Medida active: type: boolean description: Indicador se o produto está ativo no sistema. Não sendo informado um valor, será aplicado o default ativo default: true salePrice: type: number format: double description: Valor de venda do produto maximum: 999999999999999.999999 maximumDiscount: type: number format: double description: Desconto percentual unitário máximo maximum: 99999.99 defaultQuantity: type: number format: double description: Quantidade padrão do produto no pedido maximum: 99999999999999.999999 correctionFactor: type: number format: double description: Fator de correção, porcentagem do valor que inside o produto como uma correção padrão maximum: 999.99 saleType: type: integer format: int64 description: Informativo do tipo de venda padrão para o produto ipi: type: number format: double description: Porcentagem de IPI, somente descritivo maximum: 99999999.99 icms: type: number format: double description: Porcentagem de ICMS, somente descritivo maximum: 99999999.99 weight: type: number format: double description: Peso unitário do produto maximum: 999999999999.99999 note: type: string description: Obervações do tipo de oportunidade customFields: type: string description: Neste campo são informados os campos customizados desse cadastro, esses valores devem ser enviados no formato json, chaveados da seguinte forma token: type: string description: Token de identificação do CRM service: description: Entidade fachada de Serviço type: object required: – serviceCategory – token properties: id: type: integer format: int64 description: Código de identificação do CRM company: type: object allOf: – #/definitions/recordCompany description: Empresa partNumber: type: string maxLength: 45 description: Identificador do produto no sistema terceiro name: type: string maxLength: 255 description: Descritivo do grupo de empresa serviceCategory: type: object allOf: – #/definitions/recordServiceCategory description: Categoria do serviço unitMeasurement: type: object allOf: – #/definitions/recordUnitMeasurement description: Unidade de Medida active: type: boolean description: Indicador se o produto está ativo no sistema. Não sendo informado um valor, será aplicado o default ativo default: true salePrice: type: number format: double description: Valor de venda do produto maximum: 999999999999999.999999 maximumDiscount: type: number format: double description: Desconto percentual unitário máximo maximum: 99999.99 note: type: string description: Obervações do tipo de oportunidade customFields: type: string description: Neste campo são informados os campos customizados desse cadastro, esses valores devem ser enviados no formato json, chaveados da seguinte forma token: type: string description: Token de identificação do CRM opportunity: description: Entidade fachada de oportunidades – Entrada type: object required: – token properties: id: type: integer format: int64 description: Código de identificação no CRM companyBranch: type: object allOf: – #/definitions/recordCompanyBranch description: Empresa filial da oportunidade account: type: object allOf: – #/definitions/recordBasicAccount description: Conta da oportunidade contact: type: object allOf: – #/definitions/recordContact description: Contato da oportunidade opportunityName: type: string maxLength: 155 description: Nome da oportunidade opportunityType: type: object allOf: – #/definitions/recordOpportunityType description: Tipo da oportunidade opportunitySubtype: type: object allOf: – #/definitions/recordOpportunitySubtype description: Subtipo da oportunidade businessType: type: object allOf: – #/definitions/recordBusinessType description: Modalidade de negócio dateTime: type: string format: date-time description: Data e hora da criação da abertura da oportunidade opportunityOrigin: type: object allOf: – #/definitions/recordOpportunityOrigin description: Origem da oportunidade responsible: type: object allOf: – #/definitions/recordResponsible description: Responsável pela oportunidade negotiationStage: type: object allOf: – #/definitions/recordNegotiationStage description: Estágio da oportunidade lossReason: type: object allOf: – #/definitions/recordLossReason description: Motivo da perda da oportunidade salesReasons: type: object allOf: – #/definitions/recordSalesReasons description: Motivo da venda da oportunidade probability: type: integer format: int64 description: Probabilidade de fechamento da oportunidade proposalNumber: type: string maxLength: 20 description: Número da proposta no CRM orderNumber: type: string maxLength: 20 description: Número do pedido no sistema terceiro expectedClosingDate: type: string format: date description: Data da previsão de fechamento da oportunidade effectiveClosingDate: type: string format: date description: Data efetiva do fechamento da oportunidade expectedDeliveryDate: type: string format: date description: Data prevista para a entrega dos produtos effectiveDeliveryDate: type: string format: date description: Data efetiva para a entrega dos produtos expectedValue: type: number format: double description: Valor previsto da oportunidade maximum: 99999999999999.99 effectiveClosingValue: type: number format: double description: Valor fechado da oportunidade maximum: 99999999999999.99 expectedQuantity: type: number format: double description: Quantidade prevista para a oportunidade maximum: 99999999999999.99 achievedQuantity: type: number format: double description: Quantidade realizada para a oportunidade maximum: 99999999999999.99 history: type: string description: Histórico de negociação da oportunidade description: type: string description: Descrição da oportunidade notifyEmail: type: boolean description: Se notifica por email a criação da oportunidade e demais interações default: true customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM opportunityProposal: description: Entidade fachada de propostas – Entrada type: object required: – token properties: id: type: integer format: int64 description: Código de identificação no CRM opportunity: type: object allOf: – #/definitions/recordOpportunity description: Oportunidade dateTime: type: string format: date-time description: Data e hora da criação da abertura da oportunidade proposalNumber: type: string maxLength: 15 description: Número da proposta no CRM orderNumber: type: string maxLength: 50 description: Número do pedido no sistema terceiro revisionNumber: type: integer format: int64 description: Número de revisão da proposta shortName: type: string maxLength: 50 description: Nome resumido da proposta template: type: object allOf: – #/definitions/recordTemplate description: Template de relatório da proposta languageLayout: type: integer format: int64 description: Idioma do layout de proposta minimum: 1 maximum: 3 issuer: type: object allOf: – #/definitions/recordIssuer description: Emissor/criador da proposta proposalStatus: type: integer format: int64 description: Status da proposta minimum: 0 maximum: 3 paymentTerm: type: object allOf: – #/definitions/recordPaymentTerm description: Prazo de pagamento ipi: type: string maxLength: 30 description: Valor ou porcentagem de IPI da proposta icms: type: string maxLength: 30 description: Valor ou porcentagem de ICMS da proposta pis: type: string maxLength: 30 description: Valor ou porcentagem de PIS da proposta cofins: type: string maxLength: 30 description: Valor ou porcentagem de COFINS da proposta suframa: type: string maxLength: 30 description: Valor ou porcentagem de SUFRAMA da proposta zonaFranca: type: string maxLength: 30 description: Valor ou porcentagem de ZONA FRANCA da proposta carrier: type: object allOf: – #/definitions/recordCarrier description: Transportadora carrierDispatch: type: object allOf: – #/definitions/recordCarrierDispatch description: Transportadora de redespacho shippingType: type: integer format: int64 description: Tipo de frete minimum: 0 maximum: 3 otherShippingType: type: string maxLength: 15 description: Descritivo do outro tipo de frete shippingValue: type: number format: double description: Valor do frete maximum: 9999999999.99 warranty: type: string maxLength: 50 description: Garantia oferecida na prospota validity: type: string maxLength: 15 description: Validade da proposta deadlineShipping: type: string maxLength: 15 description: Prazo de entrega dos produtos/serviços groupProductCategory: type: boolean description: Informativo para agrupar os produtos/serviços por categoria sendProposalCopy: type: boolean description: Informativo para enviar uma cópia por email ao responsável da oportunidade showValues: type: boolean description: Informativo se os valores dos produtos e serviços serão exibidos na proposta impressa note: type: string description: Observações da proposta customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM opportunityProduct: description: Entidade fachada de produtos – Entrada type: object required: – token properties: id: type: integer format: int64 description: Código de identificação no CRM opportunity: type: object allOf: – #/definitions/recordOpportunity description: Oportunidade proposal: type: object allOf: – #/definitions/recordProposal description: Proposta sequenceErp: type: integer format: int64 description: Sequencial do produto no pedido product: type: object allOf: – #/definitions/recordProduct description: Produto da proposta quantity: type: number format: double description: Quantidade do produto na proposta maximum: 99999999999999.999999 deposit: type: object allOf: – #/definitions/recordDeposit description: Depósito do produto priceTable: type: object allOf: – #/definitions/recordPriceTable description: Tabela de preço do produto saleType: type: integer format: int64 description: Tipo de venda minimum: 1 maximum: 2 saleValue: type: number format: double description: Valor da vensa do produto na proposta maximum: 999999999999999.999999 applyCorrectionFactor: type: boolean description: Informativo se deve aplicar o valor de correção no valor do produto discountValue: type: number format: double description: Valor de desconto do produto maximum: 99999999999999.999999 discountPercentage: type: number format: double description: Percential de desconto do produto maximum: 99999999999999.999999 showValues: type: boolean description: Informativo de exibe o valor do produto na proposta showPhotos: type: boolean description: Informativo se exibe as fotos do produto na proposta showAttachment: type: boolean description: Informativo se apresenta os anexos do produto na proposta note: type: string description: Observações da proposta customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM opportunityService: description: Entidade fachada de serviços – Entrada type: object required: – token properties: id: type: integer format: int64 description: Código de identificação no CRM opportunity: type: object allOf: – #/definitions/recordOpportunity description: Oportunidade proposal: type: object allOf: – #/definitions/recordProposal description: Proposta sequenceErp: type: integer format: int64 description: Sequencial do produto no pedido service: type: object allOf: – #/definitions/recordService description: Serviço quantity: type: number format: double description: Quantidade do produto na proposta maximum: 99999999999999.999999 priceTable: type: object allOf: – #/definitions/recordPriceTable description: Tabela de preço do produto saleValue: type: number format: double description: Valor da vensa do produto na proposta maximum: 999999999999999.999999 discountValue: type: number format: double description: Valor de desconto do produto maximum: 99999999999999.999999 discountPercentage: type: number format: double description: Percential de desconto do produto maximum: 99999999999999.999999 showValues: type: boolean description: Informativo de exibe o valor do produto na proposta showPhotos: type: boolean description: Informativo se exibe as fotos do produto na proposta showAttachment: type: boolean description: Informativo se apresenta os anexos do produto na proposta note: type: string description: Observações da proposta customFields: type: string description: Campos customizados token: type: string description: Token de identificação do CRM 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