Contracheques / Paychecks

Cadastro de contracheque / Add paycheck

[PT] Este serviço permite o cadastro de um novo contracheque. 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 paycheck. The payload to be sent is the bellow JSON. Required fields have a asterisk mark () in "Model" tab.

post/paychecks

Request

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

Request body

idinteger

[PT]ID do Contracheque [EN]Paycheck ID

grossPaynumber required

[PT]Salário base [EN]Gross pay

netPaynumber required

[PT]Salário líquido [EN]Net pay

paycheckPeriodDatestring

[PT]Competência do contracheque com dia inicial [EN]Paycheck period with start day

personEnrolmentstring required

[PT]Matrícula do colaborador [EN]Person enrolment

paycheckPeriodNamestring required

[PT]Descrição da competência do contracheque [EN]Paycheck period description

companyNumberstring required

[PT]Número da empresa [EN]Company Number

companyExternalIdstring required

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

companyIdinteger required

[PT]ID da empresa [EN]Company ID

personExternalIdstring required

[PT]ID externo do colaborador [EN]External person ID

personIdinteger required

[PT]ID do colaborador [EN]Person ID

paycheckPeriodIdinteger required

[PT]ID da competência do contracheque [EN]Paycheck period ID

externalPaycheckPeriodIdstring required

[PT]ID externo da competência do contracheque [EN]External Paycheck period ID

baseFgtsnumber

[PT]Base FGTS [EN]Base FGTS

baseInssnumber

[PT]Base Inss [EN]Base Inss

baseIrrfnumber

[PT]Base Irrf [EN]Base Irrf

monthFgtsnumber

[PT]FGTS da competência [EN]Month FGTS

totalRevenuenumber

[PT]Total dos proventos [EN]Total Revenue

totalExpensenumber

[PT]Total dos descontos [EN]Total Expense

externalIdstring

[PT]ID externo do Contracheque [EN]Paycheck External ID

notestring

[PT]Anotação do Contracheque [EN]Paycheck note

Example request

{
  "grossPay": 459.23,
  "netPay": 459.23,
  "paycheckPeriodDate": "2018-05-01",
  "paycheckRecords": [
    {
      "description": "Horas extras 50%",
      "cost": 459.23,
      "externalId": "001"
    }
  ],
  "personEnrolment": "12-1-909",
  "paycheckPeriodName": "05/2018",
  "companyNumber": "99.999.999/9999-99",
  "companyId": 9,
  "personId": 9999,
  "baseFgts": 459.23,
  "baseInss": 459.23,
  "baseIrrf": 459.23,
  "monthFgts": 459.23,
  "totalRevenue": 1459.23,
  "totalExpense": 1459.23,
  "externalId": "1-1-11111-20170101-111"
}

Response

OK

idinteger

ID do response

messagestring

Mensagem do response

commentsstring[]

Comentários do response

Example response

{
  "value": {
    "grossPay": 459.23,
    "netPay": 459.23,
    "paycheckPeriodDate": "2018-05-01",
    "paycheckRecords": [
      {
        "description": "Horas extras 50%",
        "cost": 459.23,
        "externalId": "001"
      }
    ],
    "personEnrolment": "12-1-909",
    "paycheckPeriodName": "05/2018",
    "companyNumber": "99.999.999/9999-99",
    "companyId": 9,
    "personId": 9999,
    "baseFgts": 459.23,
    "baseInss": 459.23,
    "baseIrrf": 459.23,
    "monthFgts": 459.23,
    "totalRevenue": 1459.23,
    "totalExpense": 1459.23,
    "externalId": "1-1-11111-20170101-111"
  }
}

Changes

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