Documentos - Documents

[PT] Cadastra novo documento. [EN] Create new document

[PT] Este serviço permite o cadastro de documentos. Os campos obrigatórios estão marcados com um * na aba "Model".

[EN] This service allows to create a document. Required fields have a asterisk mark * in "Model" tab.

post/documents

Request

  • Base URL: https://api.nexti.com
  • URL: https://api.nexti.com/documents
  • Auth: OAuth 2 (client credentials, token URL https://api.nexti.com/security/oauth/token)

Request body

documentEntityIdinteger required
[PT]ID do Vínculo do documento
[ID - 2] - POSTO
[ID - 3] - COLABORADOR
[EN]Document Entity ID
[ID - 2] - WORKPLACE
[ID - 3] - PERSON
personIdinteger required
[PT]ID do colaborador vinculado ao documento
[EN]ID of person linked to document
workplaceIdinteger required
[PT]ID do posto vinculado ao documento
[EN]ID of workplace linked to document
documentTypeCustomerIdinteger required
[PT]ID do Modelo de Documento
[EN]Document Type Customer ID
issueDatestring
[PT]Data de emissão do documento
[EN]Document issue date
dueDatestring
[PT]Data de vencimento do documento
[EN]Document due date
sendOccurrenceboolean
[PT]Enviar ocorrência para a mesa de operações (sim ou não)
[EN]Send occurrence to operation desk (true or false)
notifyUsersboolean
[PT]Enviar notificação (sim ou não)
[EN]Send notification (true or false)
daysToNotifyinteger
[PT]Número de dias antes da data de vencimento em que a notificação será enviada
[EN]Number of days before due date that notification will be sent
notificationPersonIdsinteger[] 
[PT]IDs dos colaboradores notificados: para quem será enviada a notificação
[EN]IDs of persons to whom the notification will be sent
notificationPersonExternalIdsstring[] 
[PT]IDs externos dos colaboradores notificados: para quem será enviada a notificação
[EN]External IDs of persons to whom the notification will be sent
notestring
[PT]Observação
[EN]Note
documentNumberstring
[PT]Número do documento CNV
[EN]CNV document number
refresherLastDatestring
[PT]Data da última reciclagem do documento CNV
[EN]Date of last CNV document renewal
refresherDueDatestring
[PT]Data de vencimento da reciclagem do documento CNV
[EN]CNV document renewal due date

Example request

{
  "issueDate": "ddMMyyyy",
  "dueDate": "ddMMyyyy",
  "refresherLastDate": "ddMMyyyy",
  "refresherDueDate": "ddMMyyyy"
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.