Headers

• WEAL-TOKEN Required

  API token (can be retrieved from account settings)

• TARGET-ORGANIZATION-ID

  ID of organization, for which the operation must be performed

Path parameters

• id integer(int64) Required

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • id integer(int64)
  • organizationId integer(int64)
  • createdOn string(date-time) Required

    Date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

    Minimum length is 1.

  • paymentDate string(date-time) Required

    Date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

    Minimum length is 1.

  • calendarYear integer(int32)
  • monthType string

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

  • monthStartDate string(date-time)
  • monthEndDate string(date-time)
  • staffEntityId integer(int64)
  • contactEntityId integer(int64)
  • currencyId integer(int64)
  • employeeInfoId integer(int64)
  • address object
    Hide address attributes Show address attributes object

    • id integer(int64)
    • name string Required

      Minimum length is 1.

    • line1 string
    • line2 string
    • city string
    • region object
      Hide region attributes Show region attributes object

      • id integer(int64)
      • name string
      • code string
      • taxMode string

        Values are ANNUALLY or MONTHLY.

    • countryCode2 string
    • postCode string
    • toTheAttentionOf string
    • position integer(int32)
    • houseNumber string
    • countryId integer(int64) Required
    • service string
    • readOnly boolean
  • grossSalary string
  • netSalary string
  • payable string
  • description string
  • status string

    Values are UNPAID, PAID, PARTIALLY_PAID, or WIRED.

  • warnings string
  • isDeleted boolean
  • payrollLines array[object]
    Hide payrollLines attributes Show payrollLines attributes object

    • id integer(int64)
    • payrollEntityId integer(int64)
    • payslipLineEntityId integer(int64)
    • number integer(int64)
    • localizations object
      Hide localizations attributes Show localizations attributes object

      • id integer(int64)
      • en string
      • fr string
      • de string
      • it string
    • payslipValueType string

      Values are VALUE or PERCENTAGE.

    • isAutomaticallyAdded boolean
    • payslipLineType string

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

    • description string
    • baseAmount string

      Numeric value represented as string

    • employeeRate string

      Numeric value represented as string

    • employerRate string

      Numeric value represented as string

    • employeeAmount string

      Numeric value represented as string

    • employerAmount string

      Numeric value represented as string

    • specialAttributionType string

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

    • isChanged boolean
    • isShownOnSalarySlip boolean
    • orgEmployeeGroupId integer(int64)
  • payrollPayments array[object]
    Hide payrollPayments attributes Show payrollPayments attributes object

    • id integer(int64)
    • payrollEntityId integer(int64)
    • requestedDate string(date-time) Required

      Date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

      Minimum length is 1.

    • plannedDate string(date-time)

      Date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

    • sentDate string(date-time)

      Date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

    • valueDate string(date-time)

      Date in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

    • requestedAmount string

      Numeric value represented as string

    • paidAmount string

      Numeric value represented as string

    • bankCharges string

      Numeric value represented as string

    • payableByAccountId integer(int64) Required
    • payableToBankId integer(int64)
    • isFromLockedAccountingPeriod boolean
  • journalEntryId integer(int64)
  • staffPayslipId integer(int64)
  • removedPayrollLineNumbers array[integer(int64)]
  • isFromLockedAccountingPeriod boolean
  • isDocSent boolean
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error