Histórico da Página

createCustomFields

Cria um campo customizado.

Método:

createCustomFields(String user, String password, int companyId, CustomFieldsDto[] customFieldsDto)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• customFieldsDto: campo customizado que será criado.

Retorno: String, retorna OK caso os parâmetros da requisição esteja corretoestejam corretos.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

getAllCustomField

Retorna todos os campos customizados.

Método:

getAllCustomField(String user, String password, int companyId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.

Retorno: CustomFieldsDto.

getAllDocumentCustomField

Retorna todos os campos customizados de um documento.

Método:

getAllDocumentCustomField(String user, String password, int companyId, int documentId, int version)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentId: número do documento.
• version: versão do documento.

Retorno: DocumentCustomFieldsDto.

removeCustomField

Exclui um campo customizado.

Método:

removeCustomField(String user, String password, int companyId, String customFieldsId)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• customFieldsId: código do campo customizado.

Retorno: String, retorna OK caso os parâmetros da requisição esteja corretoestejam corretos. 

Estrutura de retorno com sucesso

Estrutura de retorno com erro

removeDocumentCustomField

Exclui um campo customizado de um documento.

Método:

removeDocumentCustomField(String user, String password, int companyId, String customFieldsId, int documentId, int version)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• customFieldsId: código do campo customizado.
• documentId: número do documento.
• version: versão do documento.

Retorno:

Retorno: String, retorna OK caso os parâmetros da requisição esteja corretoestejam corretos.

.

Estrutura de retorno com sucesso

Estrutura de retorno com erro

setDocumentCustomFields

Cria ou altera um campo customizado em um documento.

Método:

setDocumentCustomFields(String user, String password, int companyId, DocumentCustomFieldsDto[] documentCustomFieldsDto)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• documentCustomFieldsDto: documento com campo customizado.

Retorno: String, retorna OK caso os parâmetros da requisição esteja corretoestejam corretos. 

Estrutura de retorno com sucesso

Estrutura de retorno com erro

updateCustomFields

Altera um campo customizado.

Método:

updateCustomFields(String user, String password, int companyId, CustomFieldsDto[] customFieldsDto)

Parâmetros:

• user: login do usuário.
• password: senha do usuário.
• companyId: código da empresa.
• customFieldsDto: campo customizado que será alterado.

Retorno: String, retorna OK caso os parâmetros da requisição esteja corretoestejam corretos. 

Estrutura de retorno com sucesso

Estrutura de retorno com erro