Payslip

  • createdAt
    Type: stringFormat: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • employmentCalculationId
    Type: string
    min length:  
    1
    max length:  
    200
    required
  • employmentId
    Type: string
    min length:  
    1
    max length:  
    200
    required
  • format
    const:  
    pdf
    required
  • formatVersion
    Type: string
    required
  • id
    Type: string
    min length:  
    1
    max length:  
    200
    required
  • issues
    Type: array of object
    required

    Problems affecting Payslip generation. The array is empty unless status is failed.

    Properties: 9
  • nextAction
    Type: "none" or "wait" or "contact_support"enum
    required

    What the Partner should do next. none applies when the Payslip is available, wait while generation continues and contact_support when PayrollKit cannot complete it automatically.

  • payRunId
    Type: string
    min length:  
    1
    max length:  
    200
    required
  • status
    Type: "pending" or "available" or "failed"enum
    required

    Generation state. Wait while pending; available includes a download link; failed includes issues explaining what to do next.

  • download
    Type: object

    Send an unauthenticated GET request to the URL as supplied. Do not add the Partner API bearer token. Available Payslips use application/pdf; Payment Instruction Files and exports use text/csv; charset=utf-8. Downloads include a Content-Disposition: attachment filename. Treat the URL as sensitive and do not log or share it. After it expires, retrieve the output resource again to receive a fresh link.

    Properties: 2