Update payment file record

Updates the payment file record with the specified ID.

Request

PUT https://apisg.yourpayroll.io/api/v2/business/{businessId}/paymentfiles/{id}

Path parameters

Parameter name Value Description Additional
id int32 Required
businessId string Required

Request body

The request body takes a complete SgGiroBankModel resource, containing the following writable properties:

{
    "accountName": "string",
    "accountNumber": "string",
    "alternateCustomerReference": "string",
    "bankSwift": "string",
    "branchCode": "string",
    "bulkCustomerReference": "string",
    "confidentialIndicator": "boolean",
    "customerReference": "string",
    "fileFormat": "string",
    "id": "int32",
    "lodgementReference": "string",
    "paymentAdditionalContent": "string",
    "paymentCode": "string",
    "valueDateDaysBeforeDatePaid": "int32"
}

Properties

Name Type Description
accountName string String
accountNumber string String
alternateCustomerReference string String
bankSwift string String
branchCode string String
bulkCustomerReference string String
confidentialIndicator boolean Nullable
customerReference string String
fileFormat string GiroBankFileFormat

Possible values are:

  • None
  • DBS
  • UOB
  • OCBC
  • StandardChartered
  • Citibank
  • HSBC
  • BNPParibas
  • Mizuho
id int32 Int32
lodgementReference string String
paymentAdditionalContent string PaymentFilePaymentAdditionalContent

Possible values are:

  • None
  • PeriodEndingDate
  • PaymentDate
  • EmployeeId
  • PayRunId
paymentCode string String
valueDateDaysBeforeDatePaid int32 Nullable

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK