Skip to main content
PUT
/
payment-sheet
/
export-layout
/
{paymentSheetExportLayoutId}
Edita um layout de exportação de folha de pagamento
curl --request PUT \
  --url https://api.example.com/payment-sheet/export-layout/{paymentSheetExportLayoutId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Layout Tron",
  "referenceType": "VALUE",
  "companyStartPosition": 1,
  "companySize": 10,
  "employeeStartPosition": 15,
  "employeeSize": 10,
  "eventStartPosition": 30,
  "eventSize": 10,
  "referenceStartPosition": 45,
  "referenceSize": 7
}
'
{
  "id": "123-abc",
  "code": 7,
  "source": "Domínio",
  "description": "Layout Tron",
  "referenceType": "VALUE",
  "companyStartPosition": 1,
  "companySize": 10,
  "employeeStartPosition": 15,
  "employeeSize": 10,
  "eventStartPosition": 30,
  "eventSize": 10,
  "referenceStartPosition": 45,
  "referenceSize": 7,
  "canUpdate": true,
  "createdAt": "2025-03-02T00:00:00.000Z",
  "updatedAt": "2025-03-02T00:00:00.000Z",
  "dateStartPosition": 60,
  "dateSize": 8,
  "dateMustBreakLine": false,
  "competenceStartPosition": 70,
  "competenceSize": 6,
  "processTypeStartPosition": 80,
  "processTypeSize": 2,
  "processTypeDefaultValue": "11",
  "sequenceStartPosition": 90,
  "sequenceSize": 6,
  "startDateStartPosition": 100,
  "startDateSize": 6,
  "endDateStartPosition": 110,
  "endDateSize": 6,
  "fixedValueStartPosition": 120,
  "fixedValueSize": 2,
  "fixedValue": "10",
  "events": [
    {
      "id": "123-abc",
      "systemEvent": "ABSENCE_DATES",
      "fixedValue": "10",
      "processTypeValue": "11"
    }
  ]
}

Path Parameters

​
paymentSheetExportLayoutId
string
required

Id do layout de exportação de folha de pagamento

Example:

"a2f2cbed-e141-465c-a769-f1591be5f35c"

Body

application/json

Dados do layout

​
description
string
required

Descrição do layout de exportação de folha de pagamento

Example:

"Layout Tron"

​
referenceType
enum<string>
default:VALUE
required

Tipo de referência (valor de evento) do layout de exportação de folha de pagamento

Available options:
VALUE,
QUANTITY
​
companyStartPosition
number
required

Posição inicial do identificador da empresa

Example:

1

​
companySize
number
required

Tamanho do identificador da empresa

Example:

10

​
employeeStartPosition
number
required

Posição inicial do identificador do empregado

Example:

15

​
employeeSize
number
required

Tamanho do identificador do empregado

Example:

10

​
eventStartPosition
number
required

Posição inicial do indicador do evento

Example:

30

​
eventSize
number
required

Tamanho do indicador do evento

Example:

10

​
referenceStartPosition
number
required

Posição inicial do identificador da referência (valor do evento)

Example:

45

​
referenceSize
number
required

Tamanho do identificador da referência (valor do evento)

Example:

7

​
dateStartPosition
number

Posição inicial do identificador de eventos de data

Example:

60

​
dateSize
number

Tamanho do identificador de eventos de data

Example:

8

​
dateMustBreakLine
boolean

Indica se referências de data serão registradas em linhas subsequentes, entre o valor fixo e o tipo de processo, se houverem

Example:

false

​
competenceStartPosition
number

Posição inicial da competência (AAAAMM)

Example:

70

​
competenceSize
number

Tamanho da competência (AAAAMM)

Example:

7

​
processTypeStartPosition
number

Posição inicial do tipo de processo

Example:

80

​
processTypeSize
number

Tamanho do tipo de processo

Example:

2

​
processTypeDefaultValue
string

Valor padrão do tipo de processo

Example:

"11"

​
sequenceStartPosition
number

Posição inicial do número sequencial da linha

Example:

90

​
sequenceSize
number

Tamanho do número sequencial da linha

Example:

6

​
startDateStartPosition
number

Posição inicial da data inicial (DDMMAA)

Example:

100

​
startDateSize
number

Tamanho da data inicial (DDMMAA)

Example:

7

​
endDateStartPosition
number

Posição inicial da data final (DDMMAA)

Example:

110

​
endDateSize
number

Tamanho da data final (DDMMAA)

Example:

6

​
fixedValueStartPosition
number

Posição inicial do valor fixo

Example:

120

​
fixedValueSize
number

Tamanho do valor fixo

Example:

2

​
fixedValue
string

Valor fixo padrão

Example:

"10"

​
events
object[]

Lista de valores customizados por eventos específicos

Response

Layout editado

​
id
string
required

Id do layout de exportação de folha de pagamento

Example:

"123-abc"

​
code
number
required

Código do layout de exportação de folha de pagamento

Example:

7

​
source
string
required

Nome da fonte do layout de exportação de folha de pagamento

Example:

"Domínio"

​
description
string
required

Descrição do layout de exportação de folha de pagamento

Example:

"Layout Tron"

​
referenceType
enum<string>
default:VALUE
required

Tipo de referência (valor de evento) do layout de exportação de folha de pagamento

Available options:
VALUE,
QUANTITY
​
companyStartPosition
number
required

Posição inicial do identificador da empresa

Example:

1

​
companySize
number
required

Tamanho do identificador da empresa

Example:

10

​
employeeStartPosition
number
required

Posição inicial do identificador do empregado

Example:

15

​
employeeSize
number
required

Tamanho do identificador do empregado

Example:

10

​
eventStartPosition
number
required

Posição inicial do indicador do evento

Example:

30

​
eventSize
number
required

Tamanho do indicador do evento

Example:

10

​
referenceStartPosition
number
required

Posição inicial do identificador da referência (valor do evento)

Example:

45

​
referenceSize
number
required

Tamanho do identificador da referência (valor do evento)

Example:

7

​
canUpdate
boolean
required

Indica se o layout pode ser alterado ou excluído

Example:

true

​
createdAt
string<date-time>
required

Data de criação do layout

Example:

"2025-03-02T00:00:00.000Z"

​
updatedAt
string<date-time>
required

Data de atualização do layout

Example:

"2025-03-02T00:00:00.000Z"

​
dateStartPosition
number

Posição inicial do identificador de eventos de data

Example:

60

​
dateSize
number

Tamanho do identificador de eventos de data

Example:

8

​
dateMustBreakLine
boolean

Indica se referências de data serão registrados em linhas subsequentes, junto com o tipo de processo, se houver

Example:

false

​
competenceStartPosition
number

Posição inicial da competência (MMAAAA)

Example:

70

​
competenceSize
number

Tamanho da competência (MMAAAA)

Example:

6

​
processTypeStartPosition
number

Posição inicial do tipo de processo

Example:

80

​
processTypeSize
number

Tamanho do tipo de processo

Example:

2

​
processTypeDefaultValue
string

Valor padrão do tipo de processo

Example:

"11"

​
sequenceStartPosition
number

Posição inicial do número sequencial da linha

Example:

90

​
sequenceSize
number

Tamanho do número sequencial da linha

Example:

6

​
startDateStartPosition
number

Posição inicial da data inicial (DDMMAA)

Example:

100

​
startDateSize
number

Tamanho da data inicial (DDMMAA)

Example:

6

​
endDateStartPosition
number

Posição inicial da data final (DDMMAA)

Example:

110

​
endDateSize
number

Tamanho da data final (DDMMAA)

Example:

6

​
fixedValueStartPosition
number

Posição inicial do valor fixo

Example:

120

​
fixedValueSize
number

Tamanho do valor fixo

Example:

2

​
fixedValue
string

Valor fixo padrão

Example:

"10"

​
events
object[]

Lista de valores customizados por eventos específicos