Create BACS Settings Record

Creates a new BACS settings record for the business.

Request

POST https://api.yourpayroll.co.uk/api/v2/business/{businessId}/bacs

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "accountName": "string",
    "accountNumber": "string",
    "excludeFooter": "boolean",
    "fileFormat": "string",
    "id": "int32",
    "lodgementReference": "string",
    "mergeMultipleAccountPayments": "boolean",
    "payHmrc": "boolean",
    "paymentAdditionalContent": "string",
    "paymentDate": "int32",
    "serviceUserNumber": "string",
    "sortCode": "string"
}

Properties

Name Type Description
accountName string String
accountNumber string String
excludeFooter boolean Boolean
fileFormat string BacsFileFormat

Possible values are:

  • Standard
  • Hsbc
  • BankOfIreland
  • Barclays
  • Lloyds
  • NatWest
  • Sage
  • ClydesdaleBank
  • MetroBank
  • BarclaysPaymentFile
  • CooperativePaymentFile
  • NatWestBankLine
  • SantanderBulkBankLine
  • LloydsMultipleBacs
  • LloydsFasterPayment
  • OpenBanking
  • LloydsNonStandardBacsFormat
  • Telleroo
  • NatWestBulkBankLine
  • VirginMoney
  • StarlingBank
  • Comma
  • LloydsCboPayments
  • SantanderMultipleBacs
  • SantanderUpdatedMultipleBacs
  • RoyalBankOfScotlandBulkBankLine
id int32 Int32
lodgementReference string String
mergeMultipleAccountPayments boolean Boolean
payHmrc boolean Boolean
paymentAdditionalContent string PaymentFilePaymentAdditionalContent

Possible values are:

  • None
  • PeriodEndingDate
  • PaymentDate
  • EmployeeId
  • PayRunId
paymentDate int32 Nullable
serviceUserNumber string String
sortCode string String

Response

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

Status code Description Resource
200 OK

OK

 UkBacsApiModel