Contracheques / Paychecks

Cadastro de competência de Contracheque / Create paycheck period

[PT] Este serviço permite o cadastro de competência de Contracheques. Um JSON no formato abaixo relacionado deve ser enviado como payload. Os campos obrigatórios estão marcados com um () na aba "Model".[EN] Create a new paycheckPeriod. The payload to be sent is the bellow JSON. Required fields have a asterisk mark () in "Model" tab.

post/paychecks/createperiod/detail/period/{periodName}/company/{companyExternalId}

Request

  • Base URL: https://api.nexti.com
  • URL: https://api.nexti.com/paychecks/createperiod/detail/period/{periodName}/company/{companyExternalId}
  • Auth: OAuth 2 (client credentials, token URL https://api.nexti.com/security/oauth/token)

Path parameters

periodNamestring required

Competência do contracheque no formato MM-yyyy.

companyExternalIdstring required

Id externo da empresa.

Request body

idinteger
namestring required

[PT]Nome do Período de Contracheque [EN]Paycheck Period name

externalCompanyIdstring required

[PT]ID externo da empresa [EN]External company ID

companyIdinteger required

[PT]ID da empresa [EN]Company ID

paycheckPeriodDatestring date-time required

[PT]Data do Período de Contracheque [EN]Paycheck Period date

externalIdstring

[PT]ID externo do Período de Contracheque [EN]Paycheck Period External ID

exhibitionDatestring

[PT]Data e horário de exibição [EN]Exhibition datetime

Example request

{
  "name": "12-2017",
  "externalCompanyId": "1-001",
  "companyId": 1,
  "paycheckPeriodDate": "01012017",
  "externalId": "1-111",
  "exhibitionDate": "ddMMyyyyHHmmss"
}

Response

OK

idinteger

ID do response

messagestring

Mensagem do response

commentsstring[]

Comentários do response

Example response

{
  "value": {
    "name": "12-2017",
    "externalCompanyId": "1-001",
    "companyId": 1,
    "paycheckPeriodDate": "01012017",
    "externalId": "1-111",
    "exhibitionDate": "ddMMyyyyHHmmss"
  }
}

Changes

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