Methods

  • get - List Payment Summaries
  • put - Generate Payment Summaries

Resource

{
    "allowances": {
        "<key>": "int32"
    },
    "cdepPayments": "int32",
    "dateGenerated": "date-time",
    "deathBenefitType": "string",
    "deductibleAmountOfUndeductedAnnuityPrice": "int32",
    "employeeId": "int32",
    "employerSuperContributions": "int32",
    "employingEntityId": "int32",
    "etpCode": "string",
    "exemptForeignEmploymentIncome": "int32",
    "financialYearEnd": "date-time",
    "financialYearStart": "date-time",
    "foreignTaxPaid": "int32",
    "fringeBenefits": "int32",
    "grossPaymentType": "string",
    "grossPayments": "int32",
    "inputGrossEarnings": "double",
    "inputPreTaxDeductionAmount": "double",
    "isAmended": "boolean",
    "isDeathBenefit": "boolean",
    "isExemptFromFringeBenefitsTax": "boolean",
    "isPartOfEarlierPayment": "boolean",
    "isTransitionalTerminationPayment": "boolean",
    "lumpSumA": "int32",
    "lumpSumAType": "string",
    "lumpSumB": "int32",
    "lumpSumD": "int32",
    "lumpSumE": "int32",
    "lumpSumInArrearsTaxFreeComponent": "int32",
    "lumpSumInArrearsTaxedElement": "int32",
    "lumpSumInArrearsUntaxedElement": "int32",
    "notReportedAmount": "int32",
    "otherAmounts": [
        {
            "deductibleAmountOfUndeductedAnnuityPrice": "double",
            "exemptForeignExemptIncome": "double",
            "workPlaceGiving": "double"
        }
    ],
    "payeeABN": "string",
    "payeeAddress": "string",
    "payeeAddressLine2": "string",
    "payeeCountry": "string",
    "payeeName": "string",
    "payeePostCode": "string",
    "payeeState": "string",
    "payeeSuburb": "string",
    "payeeTaxFileNumber": "string",
    "payerABN": "string",
    "payerBranch": "string",
    "payerName": "string",
    "payerSignatory": "string",
    "paymentDate": "date-time",
    "paymentPeriodEnd": "date-time",
    "paymentPeriodStart": "date-time",
    "paymentSummaryType": "string",
    "paymentType": "string",
    "status": "string",
    "taxFreeComponent": "int32",
    "taxableComponent": "int32",
    "taxableComponentTaxFreeComponent": "int32",
    "taxableComponentTaxOffsetAmount": "int32",
    "taxableComponentTaxedElement": "int32",
    "taxableComponentUntaxedElement": "int32",
    "totalAllowances": "int32",
    "totalDeductions": "double",
    "totalTaxWithheld": "int32",
    "unionFeeDeductions": {
        "<key>": "int32"
    },
    "workplaceGiving": "int32"
}

Properties

Name Type Description
allowances object Dictionary
allowances.<key> map of int32 Int32
cdepPayments int32 Int32
dateGenerated date-time DateTime
deathBenefitType string String
deductibleAmountOfUndeductedAnnuityPrice int32 Int32
employeeId int32 Int32
employerSuperContributions int32 Int32
employingEntityId int32 Nullable
etpCode string String
exemptForeignEmploymentIncome int32 Int32
financialYearEnd date-time DateTime
financialYearStart date-time DateTime
foreignTaxPaid int32 Int32
fringeBenefits int32 Int32
grossPaymentType string String
grossPayments int32 Int32
inputGrossEarnings double Nullable
inputPreTaxDeductionAmount double Nullable
isAmended boolean Boolean
isDeathBenefit boolean Boolean
isExemptFromFringeBenefitsTax boolean Nullable
isPartOfEarlierPayment boolean Boolean
isTransitionalTerminationPayment boolean Boolean
lumpSumA int32 Int32
lumpSumAType string String
lumpSumB int32 Int32
lumpSumD int32 Int32
lumpSumE int32 Int32
lumpSumInArrearsTaxFreeComponent int32 Int32
lumpSumInArrearsTaxedElement int32 Int32
lumpSumInArrearsUntaxedElement int32 Int32
notReportedAmount int32 Int32
otherAmounts[] array
otherAmounts[].deductibleAmountOfUndeductedAnnuityPrice double Decimal
otherAmounts[].exemptForeignExemptIncome double Decimal
otherAmounts[].workPlaceGiving double Decimal
payeeABN string String
payeeAddress string String
payeeAddressLine2 string String
payeeCountry string String
payeeName string String
payeePostCode string String
payeeState string String
payeeSuburb string String
payeeTaxFileNumber string String
payerABN string String
payerBranch string String
payerName string String
payerSignatory string String
paymentDate date-time DateTime
paymentPeriodEnd date-time DateTime
paymentPeriodStart date-time DateTime
paymentSummaryType string PaygPaymentSummaryTypeEnum

Possible values are:

  • BusinessAndPersonalServicesIncome
  • EmployeeTerminationPayment
  • ForeignEmployment
  • IndividualNonBusiness
  • SuperannuationIncomeStream
  • SuperannuationLumpSum
  • PayEvent
paymentType string String
status string PaygPaymentSummaryStatus

Possible values are:

  • Generated
  • Published
  • Unpublished
taxFreeComponent int32 Int32
taxableComponent int32 Int32
taxableComponentTaxFreeComponent int32 Int32
taxableComponentTaxOffsetAmount int32 Int32
taxableComponentTaxedElement int32 Int32
taxableComponentUntaxedElement int32 Int32
totalAllowances int32 Int32
totalDeductions double Decimal
totalTaxWithheld int32 Int32
unionFeeDeductions object Dictionary
unionFeeDeductions.<key> map of int32 Int32
workplaceGiving int32 Int32