Creates a business location.

Request

POST https://keypay.yourpayroll.com.au/api/v2/business/{businessId}/location

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "defaultShiftConditionIds": [
        "int32"
    ],
    "externalId": "string",
    "fullyQualifiedName": "string",
    "generalLedgerMappingCode": "string",
    "id": "int32",
    "isGlobal": "boolean",
    "isRollupReportingLocation": "boolean",
    "name": "string",
    "parentId": "int32",
    "source": "string",
    "state": "string"
}

Properties

Name Type Description
defaultShiftConditionIds[] array of int32
externalId string String
fullyQualifiedName string String
generalLedgerMappingCode string String
id int32 Int32
isGlobal boolean Boolean
isRollupReportingLocation boolean Boolean
name string String
parentId int32 Nullable
source string String
state string String

Response

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

Status code Description Resource
200 OK

OK