Body Required

• id integer

  Entity ID. If negative value, a new entity will be created

• organizationId integer

  Organization ID

• createdOn string Required

  Creation date (format dd/MM/yyyy)

• paymentDate string Required

  Payment date (format dd/MM/yyyy). Populated from createdOn on the client side before sending

• calendarYear integer(int32)

  Calendar year

• monthType string

  Payroll month

  Values are JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, or DECEMBER.

• monthStartDate string

  Start date of the month period (format yyyy-MM-dd)

• monthEndDate string

  End date of the month period (format yyyy-MM-dd)

• staffEntityId integer

  Staff entity ID

• contactEntityId integer

  Contact entity ID linked to the staff member

• currencyId integer

  Currency ID

• employeeInfoId integer

  Employee info ID

• address object

  Delivery address for the payslip

  Hide address attributes Show address attributes object

  • id integer

    Entity ID. If negative value, a new entity will be created

  • name string

    Address label / name

  • line1 string

    Address line 1

  • line2 string

    Address line 2

  • city string

    City

  • region object

    Region

    Hide region attribute Show region attribute object

    • id integer

      Region ID

  • countryCode2 string

    ISO 3166-1 alpha-2 country code

  • countryId integer

    Country ID

  • postCode string

    Postal code

  • houseNumber string

    House number

  • toTheAttentionOf string

    To the attention of

  • position integer(int32)

    Position order

  • service string

    Service label

• grossSalary string

  Gross salary as string

• netSalary string

  Net salary as string

• payable string

  Payable amount as string

• description string

  Description or notes

• status string

  Payroll status

  Values are UNPAID, PAID, PARTIALLY_PAID, or WIRED.

• staffPayslipId integer

  Staff payslip template ID

• journalEntryId integer

  Journal entry ID linked to this payroll

• removedPayrollLineNumbers array[integer]

  Line numbers removed since last save

• payrollLines array[object]

  Request model for a payroll salary line

  Hide payrollLines attributes Show payrollLines attributes object

  Request model for a payroll salary line

  • id integer

    Entity ID. If negative value, a new entity will be created

  • payrollEntityId integer

    Payroll entity ID this line belongs to

  • payslipLineEntityId integer

    Payslip line entity (template) ID

  • number integer

    Line number for ordering

  • localizations object

    Multilingual name of the line (TranslationEntity with language fields)

    Hide localizations attributes Show localizations attributes object

    • id integer

      Entity ID. If negative value, a new entity will be created

    • en string
    • fr string
    • de string
    • it string
  • payslipValueType string

    Payslip value type

    Values are VALUE or PERCENTAGE.

  • payslipLineType string

    Payslip line type

    Values are EMPLOYEE_LINE, COMPANY_LINE, BOTH, CALCULATION, or SYSTEM.

  • isAutomaticallyAdded boolean

    Whether the line was automatically added from the payslip template

  • isChanged boolean

    Whether something was changed on this line compared to the template

  • isShownOnSalarySlip boolean

    Whether the line is shown on the salary slip

  • description string

    Custom description overriding the localized name

  • baseAmount string

    Base amount as string

  • employeeRate string

    Employee contribution rate as string

  • employerRate string

    Employer contribution rate as string

  • employeeAmount string

    Employee contribution amount as string

  • employerAmount string

    Employer contribution amount as string

  • specialAttributionType string

    Special attribution type

    Values are BASE_SALARY, GROSS_SALARY, NET_SALARY, PAYABLE, CHARGES, EMPLOYEE_ALLOCATION, or SYSTEM_LINE_ADJUSTMENT.

  • orgEmployeeGroupId integer

    Organization employee group ID

• payrollPayments array[object]

  Request model for a payroll payment

  Hide payrollPayments attributes Show payrollPayments attributes object

  Request model for a payroll payment

  • id integer

    Entity ID. If negative value, a new entity will be created

  • payrollEntityId integer

    Payroll entity ID this payment belongs to

  • requestedDate string Required

    Requested payment date (format dd/MM/yyyy)

  • plannedDate string

    Planned payment date (format dd/MM/yyyy)

  • sentDate string

    Date the payment was sent (format dd/MM/yyyy)

  • valueDate string

    Value date of the payment (format dd/MM/yyyy)

  • requestedAmount string

    Requested amount as string

  • paidAmount string

    Paid amount as string

  • bankCharges string

    Bank charges as string

  • payableByAccountId integer Required

    Chart of accounts ID used as the payable-by account

  • payableToBankId integer

    Bank ID to pay to