PayslipDelivery

  • id
    Type: string
    min length:  
    1
    max length:  
    200
    required
  • issues
    Type: array of object
    required

    Problems affecting this delivery attempt, or an empty array when there are none.

    Properties: 9
  • nextAction
    Type: stringenum
    required

    What to do next. correct_email means update the Employment's email address; PayrollKit then creates another attempt for the unchanged Payslip. wait means do not send again while PayrollKit establishes the provider outcome.

    values
    nonewaitcorrect_emailcontact_support
  • payslipId
    Type: string
    min length:  
    1
    max length:  
    200
    required
  • recipientEmail
    Type: stringFormat: email
    required
  • requestedAt
    Type: stringFormat: date-time
    required

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

  • status
    Type: stringenum
    required

    Email-provider state. accepted means the provider accepted the send, not that the employee received or read it. result_unknown means PayrollKit must establish the outcome before another send to the same address.

    values
    pendingacceptedrejectedresult_unknown
  • resolvedAt
    Type: stringFormat: date-time

    When the provider outcome became known. Omitted while the attempt is pending or its result is unknown.