account

account

24 views 23/11/2021 integrador 0

2.0info: 3.1.1 account description: Serviço responsável pelo contas do CRM x-senior-domain: crm x-senior-domain-path: crm x-senior-service-path: account contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /crm/account/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonpaths: /accountCreated: post: description: Evento de conta criada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – account properties: account: #/definitions/recAccountCreated responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountDefinitionCreated: post: description: Evento de definição de conta criada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – accountDefinition properties: accountDefinition: #/definitions/recAccountDefinitionCreated responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountPhoneCreated: post: description: Evento de telefone criado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – accountPhone properties: accountPhone: #/definitions/recAccountPhoneCreated responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountAddressCreated: post: description: Evento de endereço criado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – accountAddress properties: accountAddress: #/definitions/recAccountAddressCreated responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountUpdated: post: description: Evento de conta atualizada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – account properties: account: #/definitions/recAccountUpdated responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountDefinitionUpdated: post: description: Evento de definição de conta atualizada x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – accountDefinition properties: accountDefinition: #/definitions/recAccountDefinitionCreated responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountPhoneUpdated: post: description: Evento de telefone atualizado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – accountPhone properties: accountPhone: #/definitions/recAccountPhoneCreated responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /accountAddressUpdated: post: description: Evento de endereço atualizado x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – accountAddress properties: accountAddress: #/definitions/recAccountAddressCreated responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/crmAccount: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/crmAccount responses: 200: description: The created resource schema: #/definitions/crmAccount default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/crmAccount responses: 200: description: The created resource schema: #/definitions/crmAccount default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/crmAccount default: description: Error response schema: #/definitions/genericError /entities/crmAccount/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/crmAccount responses: 200: description: Ok schema: #/definitions/crmAccount default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/crmAccount responses: 200: description: Ok schema: #/definitions/crmAccount default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/crmAccount default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/crmAccount/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/crmAccount responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/accountPhone: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/accountPhone responses: 200: description: The created resource schema: #/definitions/accountPhone default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/accountPhone responses: 200: description: The created resource schema: #/definitions/accountPhone default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/accountPhone default: description: Error response schema: #/definitions/genericError /entities/accountPhone/{id}: put: description: This entity is customizable. tags: – Entities 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 default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities 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 default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountPhone default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/accountPhone/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountPhone responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/account: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/account responses: 200: description: The created resource schema: #/definitions/account default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/account responses: 200: description: The created resource schema: #/definitions/account default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/account default: description: Error response schema: #/definitions/genericError /entities/account/{id}: put: description: This entity is customizable. tags: – Entities 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 default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities 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 default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/account default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/account/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/account responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/accountDefinition: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/accountDefinition responses: 200: description: The created resource schema: #/definitions/accountDefinition default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/accountDefinition responses: 200: description: The created resource schema: #/definitions/accountDefinition default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/accountDefinition default: description: Error response schema: #/definitions/genericError /entities/accountDefinition/{id}: put: description: This entity is customizable. tags: – Entities 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 default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities 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 default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountDefinition default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/accountDefinition/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountDefinition responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/crmAccountPhone: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/crmAccountPhone responses: 200: description: The created resource schema: #/definitions/crmAccountPhone default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/crmAccountPhone responses: 200: description: The created resource schema: #/definitions/crmAccountPhone default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/crmAccountPhone default: description: Error response schema: #/definitions/genericError /entities/crmAccountPhone/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/crmAccountPhone responses: 200: description: Ok schema: #/definitions/crmAccountPhone default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/crmAccountPhone responses: 200: description: Ok schema: #/definitions/crmAccountPhone default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/crmAccountPhone default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/crmAccountPhone/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/crmAccountPhone responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/crmAccountAddress: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/crmAccountAddress responses: 200: description: The created resource schema: #/definitions/crmAccountAddress default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/crmAccountAddress responses: 200: description: The created resource schema: #/definitions/crmAccountAddress default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/crmAccountAddress default: description: Error response schema: #/definitions/genericError /entities/crmAccountAddress/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/crmAccountAddress responses: 200: description: Ok schema: #/definitions/crmAccountAddress default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/crmAccountAddress responses: 200: description: Ok schema: #/definitions/crmAccountAddress default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/crmAccountAddress default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/crmAccountAddress/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/crmAccountAddress responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/crmAccountDefinition: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/crmAccountDefinition responses: 200: description: The created resource schema: #/definitions/crmAccountDefinition default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/crmAccountDefinition responses: 200: description: The created resource schema: #/definitions/crmAccountDefinition default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/crmAccountDefinition default: description: Error response schema: #/definitions/genericError /entities/crmAccountDefinition/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/crmAccountDefinition responses: 200: description: Ok schema: #/definitions/crmAccountDefinition default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/crmAccountDefinition responses: 200: description: Ok schema: #/definitions/crmAccountDefinition default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/crmAccountDefinition default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/crmAccountDefinition/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/crmAccountDefinition responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/accountAddress: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/accountAddress responses: 200: description: The created resource schema: #/definitions/accountAddress default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/accountAddress responses: 200: description: The created resource schema: #/definitions/accountAddress default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/accountAddress default: description: Error response schema: #/definitions/genericError /entities/accountAddress/{id}: put: description: This entity is customizable. tags: – Entities 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 default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities 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 default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/accountAddress default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/accountAddress/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/accountAddress responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericErrordefinitions: enumPhoneType: type: string enum: – TelefoneFixo – Celular – Fax enumPhoneOperator: type: string enum: – Claro – Tim – Vivo – Oi recAccountCreated: type: object required: – name – personType – origin – accountDefinition properties: id: type: integer description: Código de identificação idErp: type: string description: Código de identificação name: type: string description: Nome da conta fantasyName: type: string description: Nome fantasia cnpj: type: string description: CNPJ da conta cpf: type: string description: CPF da conta rg: type: string description: RG da conta activityBranch: #/definitions/recActivityBranch stateRegistration: type: string description: Inscrição estadual municipalRegistration: type: string description: Inscrição municipal companySize: #/definitions/recCompanySize url: type: string description: URL do site da conta generalEmail: type: string description: E-mail geral financialEmail: type: string description: E-mail financeiro registerDate: type: string description: Data do cadastro format: date annualIncome: type: number description: Receita anual format: double employees: type: integer description: Quantidade de funcionários personType: #/definitions/recPersonType einNumber: type: string description: EIN ssnNumber: type: string description: SSN companyGroup: #/definitions/recCompanyGroup origin: #/definitions/recOrigin birthDate: type: string description: Data de nascimento/abertura format: date active: type: integer description: Status de atividade customFields: type: string description: Campos customizados accountDefinition: #/definitions/recAccountDefinition accountRenponsible: #/definitions/recAccountResponsible recActivityBranch: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro recCompanySize: type: object required: – id properties: id: type: integer description: Código de identificação recPersonType: type: object required: – id properties: id: type: integer description: Código de identificação recCompanyGroup: type: object required: – id properties: id: type: integer description: Código de identificação recOrigin: type: object required: – id properties: id: type: integer description: Código de identificação recAccountDefinition: type: object required: – id – companyBranch – company – companyErp – branch – branchErp properties: id: type: integer description: Código de identificação companyBranch: type: integer description: Empresa/filial da definição da conta company: type: integer description: Código de identificação da empresa da empresa/filial viculada companyErp: type: integer description: Código de identificação da empresa no sistema terceiro branch: type: integer description: Código de identificação da filial da empresa/filial viculada branchErp: type: integer description: Código de identificação da filial no sistema terceiro recAccountResponsible: type: object required: – user – userErp properties: user: type: integer description: Código de identificação no CRM userErp: type: integer description: Código de identificação no sistema terceiro recAccountDefinitionCreated: type: object required: – companyBranch – account – status – accountType – rating – receiveEmail – receiveSurvey – receiveTrackEmail properties: id: type: integer description: Código de identificação companyBranch: #/definitions/recCompanyBranch account: #/definitions/recAccount status: #/definitions/recStatus inactivationReason: #/definitions/recInactivationReason accountType: #/definitions/recAccountType rating: #/definitions/recRating priceTable: #/definitions/recPriceTable carrier: #/definitions/recCarrier carrierDispatch: #/definitions/recCarrierDispatch representative: #/definitions/recRepresentative seller: #/definitions/recSeller paymentTerm: #/definitions/recPaymentTerm salesGoal: type: number description: Previsão de meta de vendas para o cliente format: double note: type: string 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 description: Data de quando a conta virou cliente format: date customFields: type: string description: Campos customizados recCompanyBranch: type: object properties: id: type: integer description: Código de identificação no CRM companyErp: type: string description: Código de identificação da empresa no sistema terceiro branchErp: type: string description: Código de identificação da filial no sistema terceiro recAccount: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro recStatus: type: object required: – id properties: id: type: integer description: Código de identificação recInactivationReason: type: object required: – id properties: id: type: integer description: Código de identificação recAccountType: type: object required: – id properties: id: type: integer description: Código de identificação recRating: type: object required: – id properties: id: type: integer description: Código de identificação recPriceTable: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro recCarrier: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro recCarrierDispatch: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro recRepresentative: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro recSeller: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro recPaymentTerm: type: object properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro recAccountPhoneCreated: type: object required: – account – phoneNumber – phoneType – mainPhone properties: id: type: integer description: Código de dentificação account: #/definitions/recAccount phoneNumber: type: string description: Número de telefone phoneType: type: integer description: Tipo de telefone phoneOperator: type: integer description: Operadora da conta mainPhone: type: boolean description: Telefone principal recAccountAddressCreated: type: object required: – account – mainAddress – addressType – address – district – city – active properties: id: type: integer description: Código de identificação account: #/definitions/recAccount mainAddress: type: boolean description: Endereço principal addressType: #/definitions/recAddressType address: type: string description: Endereço number: type: integer description: Número complement: type: string description: Complemento district: type: string description: Bairro city: #/definitions/recCity cepCode: type: string description: CEP zipCode: type: string description: ZIP code latitude: type: number description: Latitude format: double longitude: type: number description: Longitude format: double active: type: integer description: Status de atividade customFields: type: string description: Campos customizados recAddressType: type: object required: – id properties: id: type: integer description: Código de identificação recCity: type: object properties: id: type: integer description: Código de identificação ibgeCode: type: string description: Código da cidade no IBGE name: type: string description: Nome da cidade uf: type: string description: UF da cidade recAccountUpdated: type: object required: – name – origin properties: id: type: integer description: Código de identificação no CRM idErp: type: string description: Código de identificação no sistema terceiro name: type: string description: Nome da conta fantasyName: type: string description: Nome fantasia cnpj: type: string description: CNPJ da conta cpf: type: string description: CPF da conta rg: type: string description: RG da conta activityBranch: #/definitions/recActivityBranch stateRegistration: type: string description: Inscrição estadual municipalRegistration: type: string description: Inscrição municipal companySize: #/definitions/recCompanySize url: type: string description: URL do site da conta generalEmail: type: string description: E-mail geral financialEmail: type: string description: E-mail financeiro registerDate: type: string description: Data do registro format: date annualIncome: type: number description: Receita anual format: double employees: type: integer description: Quantidade de funcionários personType: #/definitions/recPersonType einNumber: type: string description: EIN ssnNumber: type: string description: SSN companyGroup: #/definitions/recCompanyGroup origin: #/definitions/recOrigin birthDate: type: string description: Data de nascimento/abertura format: date active: type: integer description: Status de atividade customFields: type: string description: Campos customizados account: type: object required: – name – personType – origin properties: id: type: integer description: Código de identificação idErp: type: string description: Código de identificação name: type: string description: Nome da conta fantasyName: type: string description: Nome fantasia cnpj: type: string description: CNPJ da conta cpf: type: string description: CPF da conta rg: type: string description: RG da conta activityBranch: #/definitions/recActivityBranch stateRegistration: type: string description: Inscrição estadual municipalRegistration: type: string description: Inscrição municipal companySize: #/definitions/recCompanySize url: type: string description: URL do site da conta generalEmail: type: string description: E-mail geral financialEmail: type: string description: E-mail financeiro registerDate: type: string description: Data do cadastro format: date annualIncome: type: number description: Receita anual format: double employees: type: integer description: Quantidade de funcionários personType: #/definitions/recPersonType einNumber: type: string description: EIN ssnNumber: type: string description: SSN companyGroup: #/definitions/recCompanyGroup origin: #/definitions/recOrigin birthDate: type: string description: Data de nascimento/abertura format: date active: type: integer description: Status de atividade customFields: type: string description: Campos customizados accountDefinition: type: object required: – companyBranch – account – status – accountType – rating – receiveEmail – receiveSurvey – receiveTrackEmail properties: id: type: integer description: Código de identificação companyBranch: #/definitions/recCompanyBranch account: #/definitions/recAccount status: #/definitions/recStatus inactivationReason: #/definitions/recInactivationReason accountType: #/definitions/recAccountType rating: #/definitions/recRating priceTable: #/definitions/recPriceTable carrier: #/definitions/recCarrier carrierDispatch: #/definitions/recCarrierDispatch representative: #/definitions/recRepresentative seller: #/definitions/recSeller paymentTerm: #/definitions/recPaymentTerm salesGoal: type: number description: Previsão de meta de vendas para o cliente format: double note: type: string description: Observações da definição de conta receiveEmail: type: boolean description: Informa se a conta por definição recebe emails do sistema receiveSurvey: type: boolean description: Informa se a conta por definição recebe pesquisas do sistema receiveTrackEmail: type: boolean description: Informa se a conta por definição recebe e monitora emails do sistema clientSince: type: string description: Data de quando a conta virou cliente format: date customFields: type: string description: Campos customizados desse cadastro accountPhone: type: object required: – account – phoneNumber – phoneType – mainPhone properties: id: type: integer description: Código de identificação da definição da conta no CRM account: #/definitions/recAccount phoneNumber: type: string description: Número de telefone da conta phoneType: #/definitions/enumPhoneType phoneOperator: #/definitions/enumPhoneOperator mainPhone: type: boolean description: É o principal telefone da conta accountAddress: type: object required: – account – mainAddress – addressType – address – district – city – latitude – longitude – active properties: id: type: integer description: Código de identificação account: #/definitions/recAccount mainAddress: type: boolean description: É o endereço principal da conta addressType: #/definitions/recAddressType address: type: string description: Endereço number: type: integer description: Número complement: type: string description: Complemento district: type: string description: Bairro city: #/definitions/recCity cepCode: type: string description: CEP zipCode: type: string description: ZIP latitude: type: number description: Latitude format: double longitude: type: number description: Longitude format: double active: type: integer description: Status do endereço customFields: type: string description: Campos customizados crmAccount: type: object required: – name – personType – origin properties: id: type: integer description: Código de identificação idErp: type: string description: Código de identificação name: type: string description: Nome da conta fantasyName: type: string description: Nome fantasia cnpj: type: string description: CNPJ da conta cpf: type: string description: CPF da conta rg: type: string description: RG da conta activityBranch: #/definitions/recActivityBranch stateRegistration: type: string description: Inscrição estadual municipalRegistration: type: string description: Inscrição municipal companySize: #/definitions/recCompanySize url: type: string description: URL do site da conta generalEmail: type: string description: E-mail geral financialEmail: type: string description: E-mail financeiro registerDate: type: string description: Data do cadastro format: date annualIncome: type: number description: Receita anual format: double employees: type: integer description: Quantidade de funcionários personType: #/definitions/recPersonType einNumber: type: string description: EIN ssnNumber: type: string description: SSN companyGroup: #/definitions/recCompanyGroup origin: #/definitions/recOrigin birthDate: type: string description: Data de nascimento/abertura format: date active: type: integer description: Status de atividade customFields: type: string description: Campos customizados accountDefinition: #/definitions/recAccountDefinition accountRenponsible: #/definitions/recAccountResponsible crmAccountDefinition: type: object required: – companyBranch – account – status – accountType – rating – receiveEmail – receiveSurvey – receiveTrackEmail properties: id: type: integer description: Código de identificação companyBranch: #/definitions/recCompanyBranch account: #/definitions/recAccount status: #/definitions/recStatus inactivationReason: #/definitions/recInactivationReason accountType: #/definitions/recAccountType rating: #/definitions/recRating priceTable: #/definitions/recPriceTable carrier: #/definitions/recCarrier carrierDispatch: #/definitions/recCarrierDispatch representative: #/definitions/recRepresentative seller: #/definitions/recSeller paymentTerm: #/definitions/recPaymentTerm salesGoal: type: number description: Previsão de meta de vendas para o cliente format: double note: type: string 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 description: Data de quando a conta virou cliente format: date customFields: type: string description: Campos customizados crmAccountPhone: type: object required: – account – phoneNumber – phoneType – mainPhone properties: id: type: integer description: Código de dentificação account: #/definitions/recAccount phoneNumber: type: string description: Número de telefone phoneType: type: integer description: Tipo de telefone phoneOperator: type: integer description: Operadora da conta mainPhone: type: boolean description: Telefone principal crmAccountAddress: type: object required: – account – mainAddress – addressType – address – district – city – active properties: id: type: integer description: Código de identificação account: #/definitions/recAccount mainAddress: type: boolean description: Endereço principal addressType: #/definitions/recAddressType address: type: string description: Endereço number: type: integer description: Número complement: type: string description: Complemento district: type: string description: Bairro city: #/definitions/recCity cepCode: type: string description: CEP zipCode: type: string description: ZIP code latitude: type: number description: Latitude format: double longitude: type: number description: Longitude format: double active: type: integer description: Status de atividade customFields: type: string description: Campos customizados genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment