AccountingExport

  • 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

  • format
    const:  
    csv
    required
  • formatVersion
    const:  
    accounting-csv-v1
    required
  • groupBy
    Type: array of "department_code" or "location_code" 1…10 unique!enum
    required

    Ordered accounting dimensions used for this export, with the primary grouping first.

  • id
    Type: string
    min length:  
    1
    max length:  
    200
    required
  • payRunId
    Type: string
    min length:  
    1
    max length:  
    200
    required
  • status
    Type: stringenum
    required

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

    values
    queuedrunningavailablefailed
  • completedAt
    Type: stringFormat: date-time

    When generation completed or failed. Omitted while the export is queued or running.

  • 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
  • issues
    Type: array of object

    Problems affecting export generation. Present when status is failed.

    Properties: 9