Skip to content

Latest commit

 

History

History
179 lines (122 loc) · 8.11 KB

PayrollRunsApi.md

File metadata and controls

179 lines (122 loc) · 8.11 KB
Raw

\PayrollRunsApi

All URIs are relative to https://api.merge.dev/api/hris/v1

Method HTTP request Description
PayrollRunsList Get /payroll-runs
PayrollRunsRetrieve Get /payroll-runs/{id}

PayrollRunsList

PaginatedPayrollRunList PayrollRunsList(ctx).XAccountToken(xAccountToken).CreatedAfter(createdAfter).CreatedBefore(createdBefore).Cursor(cursor).EndedAfter(endedAfter).EndedBefore(endedBefore).IncludeDeletedData(includeDeletedData).IncludeRemoteData(includeRemoteData).ModifiedAfter(modifiedAfter).ModifiedBefore(modifiedBefore).PageSize(pageSize).RemoteId(remoteId).RunType(runType).StartedAfter(startedAfter).StartedBefore(startedBefore).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    xAccountToken := "xAccountToken_example" // string | Token identifying the end user.
    createdAfter := time.Now() // time.Time | If provided, will only return objects created after this datetime. (optional)
    createdBefore := time.Now() // time.Time | If provided, will only return objects created before this datetime. (optional)
    cursor := "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" // string | The pagination cursor value. (optional)
    endedAfter := time.Now() // time.Time | If provided, will only return payroll runs ended after this datetime. (optional)
    endedBefore := time.Now() // time.Time | If provided, will only return payroll runs ended before this datetime. (optional)
    includeDeletedData := true // bool | Whether to include data that was deleted in the third-party service. (optional)
    includeRemoteData := true // bool | Whether to include the original data Merge fetched from the third-party to produce these models. (optional)
    modifiedAfter := time.Now() // time.Time | If provided, will only return objects modified after this datetime. (optional)
    modifiedBefore := time.Now() // time.Time | If provided, will only return objects modified before this datetime. (optional)
    pageSize := int32(56) // int32 | Number of results to return per page. (optional)
    remoteId := "remoteId_example" // string | The API provider's ID for the given object. (optional)
    runType := "runType_example" // string | If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS') (optional)
    startedAfter := time.Now() // time.Time | If provided, will only return payroll runs started after this datetime. (optional)
    startedBefore := time.Now() // time.Time | If provided, will only return payroll runs started before this datetime. (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.PayrollRunsApi.PayrollRunsList(context.Background()).XAccountToken(xAccountToken).CreatedAfter(createdAfter).CreatedBefore(createdBefore).Cursor(cursor).EndedAfter(endedAfter).EndedBefore(endedBefore).IncludeDeletedData(includeDeletedData).IncludeRemoteData(includeRemoteData).ModifiedAfter(modifiedAfter).ModifiedBefore(modifiedBefore).PageSize(pageSize).RemoteId(remoteId).RunType(runType).StartedAfter(startedAfter).StartedBefore(startedBefore).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PayrollRunsApi.PayrollRunsList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PayrollRunsList`: PaginatedPayrollRunList
    fmt.Fprintf(os.Stdout, "Response from `PayrollRunsApi.PayrollRunsList`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPayrollRunsListRequest struct via the builder pattern

Name Type Description Notes
xAccountToken string Token identifying the end user.
createdAfter time.Time If provided, will only return objects created after this datetime.
createdBefore time.Time If provided, will only return objects created before this datetime.
cursor string The pagination cursor value.
endedAfter time.Time If provided, will only return payroll runs ended after this datetime.
endedBefore time.Time If provided, will only return payroll runs ended before this datetime.
includeDeletedData bool Whether to include data that was deleted in the third-party service.
includeRemoteData bool Whether to include the original data Merge fetched from the third-party to produce these models.
modifiedAfter time.Time If provided, will only return objects modified after this datetime.
modifiedBefore time.Time If provided, will only return objects modified before this datetime.
pageSize int32 Number of results to return per page.
remoteId string The API provider's ID for the given object.
runType string If provided, will only return PayrollRun's with this status. Options: ('REGULAR', 'OFF_CYCLE', 'CORRECTION', 'TERMINATION', 'SIGN_ON_BONUS')
startedAfter time.Time If provided, will only return payroll runs started after this datetime.
startedBefore time.Time If provided, will only return payroll runs started before this datetime.

Return type

PaginatedPayrollRunList

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PayrollRunsRetrieve

PayrollRun PayrollRunsRetrieve(ctx, id).XAccountToken(xAccountToken).IncludeRemoteData(includeRemoteData).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    xAccountToken := "xAccountToken_example" // string | Token identifying the end user.
    id := TODO // string | 
    includeRemoteData := true // bool | Whether to include the original data Merge fetched from the third-party to produce these models. (optional)

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.PayrollRunsApi.PayrollRunsRetrieve(context.Background(), id).XAccountToken(xAccountToken).IncludeRemoteData(includeRemoteData).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PayrollRunsApi.PayrollRunsRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PayrollRunsRetrieve`: PayrollRun
    fmt.Fprintf(os.Stdout, "Response from `PayrollRunsApi.PayrollRunsRetrieve`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Other Parameters

Other parameters are passed through a pointer to a apiPayrollRunsRetrieveRequest struct via the builder pattern

Name Type Description Notes
xAccountToken string Token identifying the end user.

includeRemoteData | bool | Whether to include the original data Merge fetched from the third-party to produce these models. |

Return type

PayrollRun

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]