Ason Payroll Integration API

Payrun periods

Endpointhttps://sandbox-api.asonpayroll.com

Endpoints for integrating Ason into your platform. API Reference also available as Swagger UI.

Queries the payouts

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/payouts

Queries the payouts › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

payrunPeriodId

string · uuid · required

The payrun period id

Queries the payouts › query Parameters

filter

string

The OData filter expression (with support for attribute fields)

orderBy

string

The OData order-by expression (with support for attribute fields)

result

string · enum

The query result type: items, count or items with count (default: result items)

The query result type

Enum values:

Items

Count

ItemsWithCount

select

string

The OData field selection expression

skip

integer · int64

The number of items in the queried collection that are to be skipped

status

string · enum

The object status (default: all status)

The object status

Enum values:

Active

Inactive

top

integer · int64

The number of items in the queried collection

Queries the payouts › Headers

Content-Type

string · required

The request content type

Default: application/json

Queries the payouts › Responses

The payouts of the payrun period matching the query, their count, or both, depending on result.

Query result

count

integer · int64

The query result count

array | null

The query result items

GET/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/payouts

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/payrunperiods/:payrunPeriodId/payouts \
  --header 'Content-Type: application/json'

shell

Example Responses

{
  "count": 0,
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "valueDate": "2024-08-25T15:00:00Z",
      "accountIban": "accountIban",
      "entries": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "status": "Active",
          "created": "2024-08-25T15:00:00Z",
          "updated": "2024-08-25T15:00:00Z",
          "payoutType": "Wage",
          "employeeId": "00000000-0000-0000-0000-000000000000",
          "amount": 0,
          "iban": "iban",
          "bankName": "bankName"
        }
      ],
      "painFile": {
        "id": "00000000-0000-0000-0000-000000000000",
        "status": "Active",
        "created": "2024-08-25T15:00:00Z",
        "updated": "2024-08-25T15:00:00Z",
        "name": "name",
        "content": "U3dhZ2dlcg==",
        "contentType": "contentType",
        "attributes": {
          "key": {}
        }
      }
    }
  ]
}

json

application/json

Create a payout for the period.

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/payouts

Create a payout for the period. › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

payrunPeriodId

string · uuid · required

The payrun period id

Create a payout for the period. › Headers

Content-Type

string · required

The request content type

Default: application/json

Create a payout for the period. › Request Body

valueDate

string · date-time

accountIban

string | null

array | null

Create a payout for the period. › Responses

The created payout.

Payout

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

valueDate

string · date-time

The value date of the payout

accountIban

string | null

The bank account to settle the payout.

array | null

The payout entries.

object

A document

POST/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/payouts

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/payrunperiods/:payrunPeriodId/payouts \
  --header 'Content-Type: application/json' \
  --data '
{
  "valueDate": "2024-08-25T15:00:00Z",
  "accountIban": "accountIban",
  "payouts": [
    {
      "employeeId": "00000000-0000-0000-0000-000000000000",
      "amount": 0
    }
  ]
}
'

shell

Example Request Body

{
  "valueDate": "2024-08-25T15:00:00Z",
  "accountIban": "accountIban",
  "payouts": [
    {
      "employeeId": "00000000-0000-0000-0000-000000000000",
      "amount": 0
    }
  ]
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "valueDate": "2024-08-25T15:00:00Z",
  "accountIban": "accountIban",
  "entries": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "payoutType": "Wage",
      "employeeId": "00000000-0000-0000-0000-000000000000",
      "amount": 0,
      "iban": "iban",
      "bankName": "bankName"
    }
  ],
  "painFile": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "Active",
    "created": "2024-08-25T15:00:00Z",
    "updated": "2024-08-25T15:00:00Z",
    "name": "name",
    "content": "U3dhZ2dlcg==",
    "contentType": "contentType",
    "attributes": {
      "key": {}
    }
  }
}

json

application/json

Get a payout

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/payouts/{payoutId}

Get a payout › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

payrunPeriodId

string · uuid · required

The payrun period id

payoutId

string · uuid · required

The payout id

Get a payout › Headers

Content-Type

string · required

The request content type

Default: application/json

Get a payout › Responses

The payout.

Payout

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

valueDate

string · date-time

The value date of the payout

accountIban

string | null

The bank account to settle the payout.

array | null

The payout entries.

object

A document

GET/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/payouts/{payoutId}

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/payrunperiods/:payrunPeriodId/payouts/:payoutId \
  --header 'Content-Type: application/json'

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "valueDate": "2024-08-25T15:00:00Z",
  "accountIban": "accountIban",
  "entries": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "payoutType": "Wage",
      "employeeId": "00000000-0000-0000-0000-000000000000",
      "amount": 0,
      "iban": "iban",
      "bankName": "bankName"
    }
  ],
  "painFile": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "Active",
    "created": "2024-08-25T15:00:00Z",
    "updated": "2024-08-25T15:00:00Z",
    "name": "name",
    "content": "U3dhZ2dlcg==",
    "contentType": "contentType",
    "attributes": {
      "key": {}
    }
  }
}

json

application/json

Cancels a payout

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/payouts/{payoutId}

Cancels a payout › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

payrunPeriodId

string · uuid · required

The payrun period id

payoutId

string · uuid · required

The payout id to cancel

Cancels a payout › Headers

Content-Type

string · required

The request content type

Default: application/json

Cancels a payout › Responses

The cancelled payout.

Payout

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

valueDate

string · date-time

The value date of the payout

accountIban

string | null

The bank account to settle the payout.

array | null

The payout entries.

object

A document

POST/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/payouts/{payoutId}

curl --request POST \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/payrunperiods/:payrunPeriodId/payouts/:payoutId \
  --header 'Content-Type: application/json'

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "valueDate": "2024-08-25T15:00:00Z",
  "accountIban": "accountIban",
  "entries": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "payoutType": "Wage",
      "employeeId": "00000000-0000-0000-0000-000000000000",
      "amount": 0,
      "iban": "iban",
      "bankName": "bankName"
    }
  ],
  "painFile": {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "Active",
    "created": "2024-08-25T15:00:00Z",
    "updated": "2024-08-25T15:00:00Z",
    "name": "name",
    "content": "U3dhZ2dlcg==",
    "contentType": "contentType",
    "attributes": {
      "key": {}
    }
  }
}

json

application/json

Gets the pain file for the payout

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/payouts/{payoutId}/document

Gets the pain file for the payout › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

payrunPeriodId

string · uuid · required

The payrun period id

payoutId

string · uuid · required

The payout id to cancel

Gets the pain file for the payout › Headers

Content-Type

string · required

The request content type

Default: application/json

Gets the pain file for the payout › Responses

The pain file of the payout as a file download, or as JSON when Accept is application/json.

A document

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

name

string | null

The document name

content

string | null · byte

The document content

contentType

string | null

The document content type

object | null

Custom attributes

Queries the payrun periods

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods

Queries the payrun periods › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Queries the payrun periods › query Parameters

filter

string

The OData filter expression (with support for attribute fields)

loadRelated

boolean

If the related objects should be loaded (default = false)

Default: false

orderBy

string

The OData order-by expression (with support for attribute fields)

result

string · enum

The query result type: items, count or items with count (default: result items)

The query result type

Enum values:

Items

Count

ItemsWithCount

select

string

The OData field selection expression

skip

integer · int64

The number of items in the queried collection that are to be skipped

status

string · enum

The object status (default: all status)

The object status

Enum values:

Active

Inactive

top

integer · int64

The number of items in the queried collection

Queries the payrun periods › Headers

Content-Type

string · required

The request content type

Default: application/json

Queries the payrun periods › Responses

The payrun periods matching the query, their count, or both, depending on result. With loadRelated, each period includes its related data.

Query result

count

integer · int64

The query result count

array | null

The query result items

GET/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/payrunperiods \
  --header 'Content-Type: application/json'

shell

Example Responses

{
  "count": 0,
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "periodStart": "2024-08-25T15:00:00Z",
      "periodEnd": "2024-08-25T15:00:00Z",
      "periodStatus": "Open",
      "documentsGeneratedAt": "2024-08-25T15:00:00Z",
      "closedAt": "2024-08-25T15:00:00Z",
      "entries": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "status": "Active",
          "created": "2024-08-25T15:00:00Z",
          "updated": "2024-08-25T15:00:00Z",
          "employeeId": "00000000-0000-0000-0000-000000000000",
          "payrunJobId": "00000000-0000-0000-0000-000000000000",
          "state": "OutOfDate",
          "openWagePayoutPreviousPeriod": 0,
          "openGarnishmentPayoutPreviousPeriod": 0,
          "identifier": "identifier",
          "lastName": "lastName",
          "firstName": "firstName",
          "leavingDate": "2024-08-25T15:00:00Z",
          "isEmployed": true,
          "grossWage": 0,
          "netWage": 0,
          "offsetting": 0,
          "employerCost": 0,
          "retro": 0,
          "garnishment": 0,
          "openWagePayout": 0,
          "openGarnishmentPayout": 0,
          "openPayout": 0,
          "paidOut": 0,
          "paidOutGarnishment": 0,
          "hasWage": true,
          "documents": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "status": "Active",
              "created": "2024-08-25T15:00:00Z",
              "updated": "2024-08-25T15:00:00Z",
              "name": "name",
              "content": "U3dhZ2dlcg==",
              "contentType": "contentType",
              "attributes": {
                "key": {}
              }
            }
          ],
          "relevantEventCount": 0
        }
      ],
      "processingStatus": "Unknown"
    }
  ]
}

json

application/json

Gets the payrun period

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}

Gets the payrun period › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

payrunPeriodId

string · uuid · required

The payrun period id

Gets the payrun period › Headers

Content-Type

string · required

The request content type

Default: application/json

Gets the payrun period › Responses

The payrun period with its related data.

Payrun period with the entries

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

periodStart

string · date-time

The period start

periodEnd

string · date-time

The period end

periodStatus

string · enum

Reflects the status of the payrun period

Enum values:

Open

Closed

Finalized

Forecast

documentsGeneratedAt

string | null · date-time

Timestamp of when the documents got generated

closedAt

string | null · date-time

Timestamp of when the payrun period got closed.

array | null

The period entries

processingStatus

string · enum

Reflects the processing status of the payrun period

Enum values:

Unknown

Complete

ReadyToGenerate

Processing

GET/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/payrunperiods/:payrunPeriodId \
  --header 'Content-Type: application/json'

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "status": "Active",
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "periodStart": "2024-08-25T15:00:00Z",
  "periodEnd": "2024-08-25T15:00:00Z",
  "periodStatus": "Open",
  "documentsGeneratedAt": "2024-08-25T15:00:00Z",
  "closedAt": "2024-08-25T15:00:00Z",
  "entries": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "status": "Active",
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "employeeId": "00000000-0000-0000-0000-000000000000",
      "payrunJobId": "00000000-0000-0000-0000-000000000000",
      "state": "OutOfDate",
      "openWagePayoutPreviousPeriod": 0,
      "openGarnishmentPayoutPreviousPeriod": 0,
      "identifier": "identifier",
      "lastName": "lastName",
      "firstName": "firstName",
      "leavingDate": "2024-08-25T15:00:00Z",
      "isEmployed": true,
      "grossWage": 0,
      "netWage": 0,
      "offsetting": 0,
      "employerCost": 0,
      "retro": 0,
      "garnishment": 0,
      "openWagePayout": 0,
      "openGarnishmentPayout": 0,
      "openPayout": 0,
      "paidOut": 0,
      "paidOutGarnishment": 0,
      "hasWage": true,
      "documents": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "status": "Active",
          "created": "2024-08-25T15:00:00Z",
          "updated": "2024-08-25T15:00:00Z",
          "name": "name",
          "content": "U3dhZ2dlcg==",
          "contentType": "contentType",
          "attributes": {
            "key": {}
          }
        }
      ],
      "relevantEventCount": 0
    }
  ],
  "processingStatus": "Unknown"
}

json

application/json

Gets the relevant event values for the payrun period entry

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/entries/{payrunPeriodEntryId}/relevantEventValues

Gets the relevant event values for the payrun period entry › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

payrunPeriodId

string · uuid · required

The payrun period id

payrunPeriodEntryId

string · uuid · required

The payrun period entry id

Gets the relevant event values for the payrun period entry › query Parameters

language

string · enum

The language

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

Gets the relevant event values for the payrun period entry › Headers

Content-Type

string · required

The request content type

Default: application/json

Gets the relevant event values for the payrun period entry › Responses

The relevant event values of the payrun period entry.

object[]

The payroll case value API object (immutable)

caseFieldName

string · minLength: 0 · maxLength: 128 · required

The associated case field name

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

caseChangeId

string · uuid

The case change id (immutable)

divisionId

string | null · uuid

The division id (immutable) Mandatory for case values with local value scope Ason.Payroll.Api.Model.CaseField.ValueScope

employeeId

string | null · uuid

The employee id, mandatory for employee case changes

caseName

string | null · minLength: 0 · maxLength: 128

The associated case name

object | null

The localized case names

displayCaseName

string | null

The localized case name

object | null

The localized case field names

displayCaseFieldName

string | null

The localized case field name

valueType

string · enum

The payroll value types for cases

Enum values:

String

Boolean

Integer

NumericBoolean

Decimal

DateTime

None

Date

value

string | null

The case value (JSON format)

numericValue

number | null · double

The case numeric value

cancellationDate

string | null · date-time

Cancellation date

start

string | null · date-time

The starting date for the value

end

string | null · date-time

The ending date for the value

forecast

string | null · minLength: 0 · maxLength: 128

The forecast name

tags

array | null

The case value tags

object | null

Custom attributes

GET/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/entries/{payrunPeriodEntryId}/relevantEventValues

curl --request GET \
  --url https://sandbox-api.asonpayroll.com/api/tenants/:tenantId/payrolls/:payrollId/payrunperiods/:payrunPeriodId/entries/:payrunPeriodEntryId/relevantEventValues \
  --header 'Content-Type: application/json'

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "status": "Active",
    "created": "2024-08-25T15:00:00Z",
    "updated": "2024-08-25T15:00:00Z",
    "caseChangeId": "00000000-0000-0000-0000-000000000000",
    "divisionId": "00000000-0000-0000-0000-000000000000",
    "employeeId": "00000000-0000-0000-0000-000000000000",
    "caseName": "caseName",
    "caseNameLocalizations": {
      "key": "string"
    },
    "displayCaseName": "displayCaseName",
    "caseFieldName": "caseFieldName",
    "caseFieldNameLocalizations": {
      "key": "string"
    },
    "displayCaseFieldName": "displayCaseFieldName",
    "valueType": "String",
    "value": "value",
    "numericValue": 0,
    "cancellationDate": "2024-08-25T15:00:00Z",
    "start": "2024-08-25T15:00:00Z",
    "end": "2024-08-25T15:00:00Z",
    "forecast": "forecast",
    "tags": [
      "string"
    ],
    "attributes": {
      "key": {}
    }
  }
]

json

application/json

Queries controlling data of open payrun period

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/open/controlling

Queries controlling data of open payrun period › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Queries controlling data of open payrun period › query Parameters

language

string · enum

The language

The payroll languages

Enum values:

English

Afrikaans

Arabic

Azerbaijani

Belarusian

Bulgarian

Bosnian

Czech

Queries controlling data of open payrun period › Headers

Content-Type

string · required

The request content type

Default: application/json

Queries controlling data of open payrun period › Responses

The controlling data of the open payrun period, or empty controlling data when no period is open.

array | null

Closes the open period

POST

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/close

Closes the open period › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

payrunPeriodId

string · uuid · required

The payrun period id

Closes the open period › Headers

Content-Type

string · required

The request content type

Default: application/json

Closes the open period › Responses

The payrun period was closed.

No data returned

Gets the open payrun period documents

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/open/documents

Gets the open payrun period documents › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

Gets the open payrun period documents › Headers

Content-Type

string · required

The request content type

Default: application/json

Gets the open payrun period documents › Responses

The documents of the open payrun period, generated on request and sorted by name.

object[]

A document

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

name

string | null

The document name

content

string | null · byte

The document content

contentType

string | null

The document content type

object | null

Custom attributes

Gets the payrun period documents

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/documents

Gets the payrun period documents › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

payrunPeriodId

string · uuid · required

The payrun period id

Gets the payrun period documents › Headers

Content-Type

string · required

The request content type

Default: application/json

Gets the payrun period documents › Responses

The documents of the payrun period, sorted by name.

object[]

A document

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

name

string | null

The document name

content

string | null · byte

The document content

contentType

string | null

The document content type

object | null

Custom attributes

Gets the document for the payrun period

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/documents/{documentId}

Gets the document for the payrun period › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

payrunPeriodId

string · uuid · required

The payrun period id

documentId

string · uuid · required

The document id

Gets the document for the payrun period › query Parameters

report

string

The report to generate based on the document (default: null)

variant

string

The variant of the report (if applicable) (default: null)

Gets the document for the payrun period › Headers

Content-Type

string · required

The request content type

Default: application/json

Gets the document for the payrun period › Responses

The document as a file download, rendered as PDF when report is set, or as JSON when Accept is application/json.

No data returned

Gets the payrun period entry documents

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/entries/{payrunPeriodEntryId}/documents

Gets the payrun period entry documents › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

payrunPeriodId

string · uuid · required

The payrun period id

payrunPeriodEntryId

string · uuid · required

The payrun period entry id

Gets the payrun period entry documents › Headers

Content-Type

string · required

The request content type

Default: application/json

Gets the payrun period entry documents › Responses

The documents of the payrun period entry, sorted by name.

object[]

A document

id

string · uuid

The unique object id (immutable)

status

string · enum

The object status

Enum values:

Active

Inactive

created

string · date-time

The date which the API object was created (immutable)

updated

string · date-time

The date which the API object was last updated (immutable)

name

string | null

The document name

content

string | null · byte

The document content

contentType

string | null

The document content type

object | null

Custom attributes

Gets the document for the payrun period entry

GET

https://sandbox-api.asonpayroll.com

/api/tenants/{tenantId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/entries/{payrunPeriodEntryId}/documents/{documentId}

Gets the document for the payrun period entry › path Parameters

tenantId

string · uuid · required

The tenant id

payrollId

string · uuid · required

The payroll id

payrunPeriodId

string · uuid · required

The payrun period id

payrunPeriodEntryId

string · uuid · required

The payrun period entry id

documentId

string · uuid · required

The document id

Gets the document for the payrun period entry › query Parameters

report

string

The report to generate based on the document (default: null)

variant

string

The variant of the report (if applicable) (default: null)

Gets the document for the payrun period entry › Headers

Content-Type

string · required

The request content type

Default: application/json

Gets the document for the payrun period entry › Responses

The document as a file download, rendered as PDF when report is set, or as JSON when Accept is application/json.

No data returned

Tasks Divisions