POST api/Locations

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LocationID	integer	None.
LocationCode	string	String length: inclusive between 0 and 100
ClientID	integer	None.
ClientCode	string	String length: inclusive between 0 and 50
LocationDescription	string	String length: inclusive between 0 and 100
IsClientDefault	string	String length: inclusive between 0 and 2
CountryCode	string	String length: inclusive between 0 and 2000
CurrencyCode	string	String length: inclusive between 0 and 10
PrimaryContactID	integer	None.
LocOfficePhone	string	String length: inclusive between 0 and 20
LocMobilePhone	string	String length: inclusive between 0 and 20
LocFax	string	String length: inclusive between 0 and 20
LocEmail1	string	String length: inclusive between 0 and 100
LocEmail2	string	String length: inclusive between 0 and 100
LocWebsite	string	String length: inclusive between 0 and 100
LocAddress1	string	String length: inclusive between 0 and 100
LocAddress2	string	String length: inclusive between 0 and 100
LocCity	string	String length: inclusive between 0 and 100
LocStateProvince	string	String length: inclusive between 0 and 50
LocPostalCode	string	String length: inclusive between 0 and 30
SecondaryContactID	integer	None.
TertiaryContactID	integer	None.
LocMailTo	string	String length: inclusive between 0 and 200
StateCode	string	String length: inclusive between 0 and 40
CompCollectionInterval	string	String length: inclusive between 0 and 20
NextCompCollectionDate	date	None.
CompCollectionReminderInterval	string	String length: inclusive between 0 and 20
CompCollectionReminderCount	integer	None.
NextCompCollectionReminderDate	date	None.
CompCollectionEmailTemplate	string	String length: inclusive between 0 and 100
CompCollectionReminderTemplate	string	String length: inclusive between 0 and 100
CompCollectionImportTemplate	string	String length: inclusive between 0 and 100
ShadowPayroll	string	String length: inclusive between 0 and 1
ShadowThroughDetailExpense	string	String length: inclusive between 0 and 1
ShadowReportedLocationCode	string	String length: inclusive between 0 and 50
ShadowReportedLocationID	integer	None.
SplitPayGrossNet	string	String length: inclusive between 0 and 50
RecurringOpt	string	String length: inclusive between 0 and 30
NonSplitPayGrossNet	string	String length: inclusive between 0 and 50
defMethod	string	String length: inclusive between 0 and 50
LocStatus	string	String length: inclusive between 0 and 2
LocGroup	string	String length: inclusive between 0 and 100
PIThroughDE	string	String length: inclusive between 0 and 1
OVRCurr	string	String length: inclusive between 0 and 10
LocGSOESeq	decimal number	None.
OnlyEligibleForTaxServices	string	String length: inclusive between 0 and 2
EarnCodeExclusionList	string	None.
LocSalaryFrequency	integer	None.
LocBSFrequencyHome	integer	None.
LocBSFrequencyHost	integer	None.
LocPIFrequencyHome	integer	None.
LocPIFrequencyHost	integer	None.
LocBSFrequency	integer	None.
LocPIFrequency	integer	None.
ID	integer	None.
BalanceSheetEmailTemplate	string	String length: inclusive between 0 and 100
BalanceSheetEmailTo	string	String length: inclusive between 0 and 50
BalanceSheetCC	string	String length: inclusive between 0 and 2000
BalanceSheetBCC	string	String length: inclusive between 0 and 2000
IgnoreValueMultForCC	string	String length: inclusive between 0 and 2
SendRemindersToRepos	string	String length: inclusive between 0 and 2
PeriodBegDate	date	None.
PeriodEndDate	date	None.

Request Formats

application/json, text/json

Sample:

{
  "LocationID": 1,
  "LocationCode": "sample string 2",
  "ClientID": 1,
  "ClientCode": "sample string 3",
  "LocationDescription": "sample string 4",
  "IsClientDefault": "sample string 5",
  "CountryCode": "sample string 6",
  "CurrencyCode": "sample string 7",
  "PrimaryContactID": 1,
  "LocOfficePhone": "sample string 8",
  "LocMobilePhone": "sample string 9",
  "LocFax": "sample string 10",
  "LocEmail1": "sample string 11",
  "LocEmail2": "sample string 12",
  "LocWebsite": "sample string 13",
  "LocAddress1": "sample string 14",
  "LocAddress2": "sample string 15",
  "LocCity": "sample string 16",
  "LocStateProvince": "sample string 17",
  "LocPostalCode": "sample string 18",
  "SecondaryContactID": 1,
  "TertiaryContactID": 1,
  "LocMailTo": "sample string 19",
  "StateCode": "sample string 20",
  "CompCollectionInterval": "sample string 21",
  "NextCompCollectionDate": "2025-05-09T17:42:34.7888583+00:00",
  "CompCollectionReminderInterval": "sample string 22",
  "CompCollectionReminderCount": 1,
  "NextCompCollectionReminderDate": "2025-05-09T17:42:34.7888583+00:00",
  "CompCollectionEmailTemplate": "sample string 23",
  "CompCollectionReminderTemplate": "sample string 24",
  "CompCollectionImportTemplate": "sample string 25",
  "ShadowPayroll": "sample string 26",
  "ShadowThroughDetailExpense": "sample string 27",
  "ShadowReportedLocationCode": "sample string 28",
  "ShadowReportedLocationID": 1,
  "SplitPayGrossNet": "sample string 29",
  "RecurringOpt": "sample string 30",
  "NonSplitPayGrossNet": "sample string 31",
  "defMethod": "sample string 32",
  "LocStatus": "sample string 33",
  "LocGroup": "sample string 34",
  "PIThroughDE": "sample string 35",
  "OVRCurr": "sample string 36",
  "LocGSOESeq": 1.0,
  "OnlyEligibleForTaxServices": "sample string 37",
  "EarnCodeExclusionList": "sample string 38",
  "LocSalaryFrequency": 1,
  "LocBSFrequencyHome": 1,
  "LocBSFrequencyHost": 1,
  "LocPIFrequencyHome": 1,
  "LocPIFrequencyHost": 1,
  "LocBSFrequency": 1,
  "LocPIFrequency": 1,
  "ID": 39,
  "BalanceSheetEmailTemplate": "sample string 40",
  "BalanceSheetEmailTo": "sample string 41",
  "BalanceSheetCC": "sample string 42",
  "BalanceSheetBCC": "sample string 43",
  "IgnoreValueMultForCC": "sample string 44",
  "SendRemindersToRepos": "sample string 45",
  "PeriodBegDate": "2025-05-09T17:42:34.8045045+00:00",
  "PeriodEndDate": "2025-05-09T17:42:34.8045045+00:00"
}

application/xml, text/xml

Sample:

<Location xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fabric">
  <BalanceSheetBCC>sample string 43</BalanceSheetBCC>
  <BalanceSheetCC>sample string 42</BalanceSheetCC>
  <BalanceSheetEmailTemplate>sample string 40</BalanceSheetEmailTemplate>
  <BalanceSheetEmailTo>sample string 41</BalanceSheetEmailTo>
  <ClientCode>sample string 3</ClientCode>
  <ClientID>1</ClientID>
  <CompCollectionEmailTemplate>sample string 23</CompCollectionEmailTemplate>
  <CompCollectionImportTemplate>sample string 25</CompCollectionImportTemplate>
  <CompCollectionInterval>sample string 21</CompCollectionInterval>
  <CompCollectionReminderCount>1</CompCollectionReminderCount>
  <CompCollectionReminderInterval>sample string 22</CompCollectionReminderInterval>
  <CompCollectionReminderTemplate>sample string 24</CompCollectionReminderTemplate>
  <CountryCode>sample string 6</CountryCode>
  <CurrencyCode>sample string 7</CurrencyCode>
  <EarnCodeExclusionList>sample string 38</EarnCodeExclusionList>
  <ID>39</ID>
  <IgnoreValueMultForCC>sample string 44</IgnoreValueMultForCC>
  <IsClientDefault>sample string 5</IsClientDefault>
  <LocAddress1>sample string 14</LocAddress1>
  <LocAddress2>sample string 15</LocAddress2>
  <LocBSFrequency>1</LocBSFrequency>
  <LocBSFrequencyHome>1</LocBSFrequencyHome>
  <LocBSFrequencyHost>1</LocBSFrequencyHost>
  <LocCity>sample string 16</LocCity>
  <LocEmail1>sample string 11</LocEmail1>
  <LocEmail2>sample string 12</LocEmail2>
  <LocFax>sample string 10</LocFax>
  <LocGSOESeq>1</LocGSOESeq>
  <LocGroup>sample string 34</LocGroup>
  <LocMailTo>sample string 19</LocMailTo>
  <LocMobilePhone>sample string 9</LocMobilePhone>
  <LocOfficePhone>sample string 8</LocOfficePhone>
  <LocPIFrequency>1</LocPIFrequency>
  <LocPIFrequencyHome>1</LocPIFrequencyHome>
  <LocPIFrequencyHost>1</LocPIFrequencyHost>
  <LocPostalCode>sample string 18</LocPostalCode>
  <LocSalaryFrequency>1</LocSalaryFrequency>
  <LocStateProvince>sample string 17</LocStateProvince>
  <LocStatus>sample string 33</LocStatus>
  <LocWebsite>sample string 13</LocWebsite>
  <LocationCode>sample string 2</LocationCode>
  <LocationDescription>sample string 4</LocationDescription>
  <LocationID>1</LocationID>
  <NextCompCollectionDate>2025-05-09T17:42:34.7888583+00:00</NextCompCollectionDate>
  <NextCompCollectionReminderDate>2025-05-09T17:42:34.7888583+00:00</NextCompCollectionReminderDate>
  <NonSplitPayGrossNet>sample string 31</NonSplitPayGrossNet>
  <OVRCurr>sample string 36</OVRCurr>
  <OnlyEligibleForTaxServices>sample string 37</OnlyEligibleForTaxServices>
  <PIThroughDE>sample string 35</PIThroughDE>
  <PeriodBegDate>2025-05-09T17:42:34.8045045+00:00</PeriodBegDate>
  <PeriodEndDate>2025-05-09T17:42:34.8045045+00:00</PeriodEndDate>
  <PrimaryContactID>1</PrimaryContactID>
  <RecurringOpt>sample string 30</RecurringOpt>
  <SecondaryContactID>1</SecondaryContactID>
  <SendRemindersToRepos>sample string 45</SendRemindersToRepos>
  <ShadowPayroll>sample string 26</ShadowPayroll>
  <ShadowReportedLocationCode>sample string 28</ShadowReportedLocationCode>
  <ShadowReportedLocationID>1</ShadowReportedLocationID>
  <ShadowThroughDetailExpense>sample string 27</ShadowThroughDetailExpense>
  <SplitPayGrossNet>sample string 29</SplitPayGrossNet>
  <StateCode>sample string 20</StateCode>
  <TertiaryContactID>1</TertiaryContactID>
  <defMethod>sample string 32</defMethod>
</Location>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Location

Name	Type	Additional information
LocationID	integer	None.
LocationCode	string	String length: inclusive between 0 and 100
ClientID	integer	None.
ClientCode	string	String length: inclusive between 0 and 50
LocationDescription	string	String length: inclusive between 0 and 100
IsClientDefault	string	String length: inclusive between 0 and 2
CountryCode	string	String length: inclusive between 0 and 2000
CurrencyCode	string	String length: inclusive between 0 and 10
PrimaryContactID	integer	None.
LocOfficePhone	string	String length: inclusive between 0 and 20
LocMobilePhone	string	String length: inclusive between 0 and 20
LocFax	string	String length: inclusive between 0 and 20
LocEmail1	string	String length: inclusive between 0 and 100
LocEmail2	string	String length: inclusive between 0 and 100
LocWebsite	string	String length: inclusive between 0 and 100
LocAddress1	string	String length: inclusive between 0 and 100
LocAddress2	string	String length: inclusive between 0 and 100
LocCity	string	String length: inclusive between 0 and 100
LocStateProvince	string	String length: inclusive between 0 and 50
LocPostalCode	string	String length: inclusive between 0 and 30
SecondaryContactID	integer	None.
TertiaryContactID	integer	None.
LocMailTo	string	String length: inclusive between 0 and 200
StateCode	string	String length: inclusive between 0 and 40
CompCollectionInterval	string	String length: inclusive between 0 and 20
NextCompCollectionDate	date	None.
CompCollectionReminderInterval	string	String length: inclusive between 0 and 20
CompCollectionReminderCount	integer	None.
NextCompCollectionReminderDate	date	None.
CompCollectionEmailTemplate	string	String length: inclusive between 0 and 100
CompCollectionReminderTemplate	string	String length: inclusive between 0 and 100
CompCollectionImportTemplate	string	String length: inclusive between 0 and 100
ShadowPayroll	string	String length: inclusive between 0 and 1
ShadowThroughDetailExpense	string	String length: inclusive between 0 and 1
ShadowReportedLocationCode	string	String length: inclusive between 0 and 50
ShadowReportedLocationID	integer	None.
SplitPayGrossNet	string	String length: inclusive between 0 and 50
RecurringOpt	string	String length: inclusive between 0 and 30
NonSplitPayGrossNet	string	String length: inclusive between 0 and 50
defMethod	string	String length: inclusive between 0 and 50
LocStatus	string	String length: inclusive between 0 and 2
LocGroup	string	String length: inclusive between 0 and 100
PIThroughDE	string	String length: inclusive between 0 and 1
OVRCurr	string	String length: inclusive between 0 and 10
LocGSOESeq	decimal number	None.
OnlyEligibleForTaxServices	string	String length: inclusive between 0 and 2
EarnCodeExclusionList	string	None.
LocSalaryFrequency	integer	None.
LocBSFrequencyHome	integer	None.
LocBSFrequencyHost	integer	None.
LocPIFrequencyHome	integer	None.
LocPIFrequencyHost	integer	None.
LocBSFrequency	integer	None.
LocPIFrequency	integer	None.
ID	integer	None.
BalanceSheetEmailTemplate	string	String length: inclusive between 0 and 100
BalanceSheetEmailTo	string	String length: inclusive between 0 and 50
BalanceSheetCC	string	String length: inclusive between 0 and 2000
BalanceSheetBCC	string	String length: inclusive between 0 and 2000
IgnoreValueMultForCC	string	String length: inclusive between 0 and 2
SendRemindersToRepos	string	String length: inclusive between 0 and 2
PeriodBegDate	date	None.
PeriodEndDate	date	None.

Response Formats

application/json, text/json

Sample:

{
  "LocationID": 1,
  "LocationCode": "sample string 2",
  "ClientID": 1,
  "ClientCode": "sample string 3",
  "LocationDescription": "sample string 4",
  "IsClientDefault": "sample string 5",
  "CountryCode": "sample string 6",
  "CurrencyCode": "sample string 7",
  "PrimaryContactID": 1,
  "LocOfficePhone": "sample string 8",
  "LocMobilePhone": "sample string 9",
  "LocFax": "sample string 10",
  "LocEmail1": "sample string 11",
  "LocEmail2": "sample string 12",
  "LocWebsite": "sample string 13",
  "LocAddress1": "sample string 14",
  "LocAddress2": "sample string 15",
  "LocCity": "sample string 16",
  "LocStateProvince": "sample string 17",
  "LocPostalCode": "sample string 18",
  "SecondaryContactID": 1,
  "TertiaryContactID": 1,
  "LocMailTo": "sample string 19",
  "StateCode": "sample string 20",
  "CompCollectionInterval": "sample string 21",
  "NextCompCollectionDate": "2025-05-09T17:42:34.8357572+00:00",
  "CompCollectionReminderInterval": "sample string 22",
  "CompCollectionReminderCount": 1,
  "NextCompCollectionReminderDate": "2025-05-09T17:42:34.8357572+00:00",
  "CompCollectionEmailTemplate": "sample string 23",
  "CompCollectionReminderTemplate": "sample string 24",
  "CompCollectionImportTemplate": "sample string 25",
  "ShadowPayroll": "sample string 26",
  "ShadowThroughDetailExpense": "sample string 27",
  "ShadowReportedLocationCode": "sample string 28",
  "ShadowReportedLocationID": 1,
  "SplitPayGrossNet": "sample string 29",
  "RecurringOpt": "sample string 30",
  "NonSplitPayGrossNet": "sample string 31",
  "defMethod": "sample string 32",
  "LocStatus": "sample string 33",
  "LocGroup": "sample string 34",
  "PIThroughDE": "sample string 35",
  "OVRCurr": "sample string 36",
  "LocGSOESeq": 1.0,
  "OnlyEligibleForTaxServices": "sample string 37",
  "EarnCodeExclusionList": "sample string 38",
  "LocSalaryFrequency": 1,
  "LocBSFrequencyHome": 1,
  "LocBSFrequencyHost": 1,
  "LocPIFrequencyHome": 1,
  "LocPIFrequencyHost": 1,
  "LocBSFrequency": 1,
  "LocPIFrequency": 1,
  "ID": 39,
  "BalanceSheetEmailTemplate": "sample string 40",
  "BalanceSheetEmailTo": "sample string 41",
  "BalanceSheetCC": "sample string 42",
  "BalanceSheetBCC": "sample string 43",
  "IgnoreValueMultForCC": "sample string 44",
  "SendRemindersToRepos": "sample string 45",
  "PeriodBegDate": "2025-05-09T17:42:34.8357572+00:00",
  "PeriodEndDate": "2025-05-09T17:42:34.8357572+00:00"
}

application/xml, text/xml

Sample:

<Location xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fabric">
  <BalanceSheetBCC>sample string 43</BalanceSheetBCC>
  <BalanceSheetCC>sample string 42</BalanceSheetCC>
  <BalanceSheetEmailTemplate>sample string 40</BalanceSheetEmailTemplate>
  <BalanceSheetEmailTo>sample string 41</BalanceSheetEmailTo>
  <ClientCode>sample string 3</ClientCode>
  <ClientID>1</ClientID>
  <CompCollectionEmailTemplate>sample string 23</CompCollectionEmailTemplate>
  <CompCollectionImportTemplate>sample string 25</CompCollectionImportTemplate>
  <CompCollectionInterval>sample string 21</CompCollectionInterval>
  <CompCollectionReminderCount>1</CompCollectionReminderCount>
  <CompCollectionReminderInterval>sample string 22</CompCollectionReminderInterval>
  <CompCollectionReminderTemplate>sample string 24</CompCollectionReminderTemplate>
  <CountryCode>sample string 6</CountryCode>
  <CurrencyCode>sample string 7</CurrencyCode>
  <EarnCodeExclusionList>sample string 38</EarnCodeExclusionList>
  <ID>39</ID>
  <IgnoreValueMultForCC>sample string 44</IgnoreValueMultForCC>
  <IsClientDefault>sample string 5</IsClientDefault>
  <LocAddress1>sample string 14</LocAddress1>
  <LocAddress2>sample string 15</LocAddress2>
  <LocBSFrequency>1</LocBSFrequency>
  <LocBSFrequencyHome>1</LocBSFrequencyHome>
  <LocBSFrequencyHost>1</LocBSFrequencyHost>
  <LocCity>sample string 16</LocCity>
  <LocEmail1>sample string 11</LocEmail1>
  <LocEmail2>sample string 12</LocEmail2>
  <LocFax>sample string 10</LocFax>
  <LocGSOESeq>1</LocGSOESeq>
  <LocGroup>sample string 34</LocGroup>
  <LocMailTo>sample string 19</LocMailTo>
  <LocMobilePhone>sample string 9</LocMobilePhone>
  <LocOfficePhone>sample string 8</LocOfficePhone>
  <LocPIFrequency>1</LocPIFrequency>
  <LocPIFrequencyHome>1</LocPIFrequencyHome>
  <LocPIFrequencyHost>1</LocPIFrequencyHost>
  <LocPostalCode>sample string 18</LocPostalCode>
  <LocSalaryFrequency>1</LocSalaryFrequency>
  <LocStateProvince>sample string 17</LocStateProvince>
  <LocStatus>sample string 33</LocStatus>
  <LocWebsite>sample string 13</LocWebsite>
  <LocationCode>sample string 2</LocationCode>
  <LocationDescription>sample string 4</LocationDescription>
  <LocationID>1</LocationID>
  <NextCompCollectionDate>2025-05-09T17:42:34.8357572+00:00</NextCompCollectionDate>
  <NextCompCollectionReminderDate>2025-05-09T17:42:34.8357572+00:00</NextCompCollectionReminderDate>
  <NonSplitPayGrossNet>sample string 31</NonSplitPayGrossNet>
  <OVRCurr>sample string 36</OVRCurr>
  <OnlyEligibleForTaxServices>sample string 37</OnlyEligibleForTaxServices>
  <PIThroughDE>sample string 35</PIThroughDE>
  <PeriodBegDate>2025-05-09T17:42:34.8357572+00:00</PeriodBegDate>
  <PeriodEndDate>2025-05-09T17:42:34.8357572+00:00</PeriodEndDate>
  <PrimaryContactID>1</PrimaryContactID>
  <RecurringOpt>sample string 30</RecurringOpt>
  <SecondaryContactID>1</SecondaryContactID>
  <SendRemindersToRepos>sample string 45</SendRemindersToRepos>
  <ShadowPayroll>sample string 26</ShadowPayroll>
  <ShadowReportedLocationCode>sample string 28</ShadowReportedLocationCode>
  <ShadowReportedLocationID>1</ShadowReportedLocationID>
  <ShadowThroughDetailExpense>sample string 27</ShadowThroughDetailExpense>
  <SplitPayGrossNet>sample string 29</SplitPayGrossNet>
  <StateCode>sample string 20</StateCode>
  <TertiaryContactID>1</TertiaryContactID>
  <defMethod>sample string 32</defMethod>
</Location>