PUT v1/CustomerNumbers/Put?locationID={locationID}

Update the location's customer number settings

Request Information

URI Parameters

NameDescriptionTypeAdditional information
locationID

Id of the location

string

Required

Body Parameters

Invoice number value

SequenceValueDTO
NameDescriptionTypeAdditional information
NextNumberShouldBe

integer

None.

Suffix

string

None.

Prefix

string

None.

Request Formats

application/json, text/json

Sample:
{
  "NextNumberShouldBe": 1,
  "Suffix": "sample string 2",
  "Prefix": "sample string 3"
}

application/xml, text/xml

Sample:
<SequenceValueDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Locations">
  <NextNumberShouldBe>1</NextNumberShouldBe>
  <Prefix>sample string 3</Prefix>
  <Suffix>sample string 2</Suffix>
</SequenceValueDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SequenceValueDTO'.

Response Information

Resource Description

Updated customer number settings

ActionResultDTOOfSequenceNumberDTO
NameDescriptionTypeAdditional information
Result

SequenceNumberDTO

None.

CreatedBy

string

None.

EntityID

integer

None.

RowSource

string

None.

PolicyID

integer

None.

IsSuccess

boolean

None.

ErrorCode

string

None.

ErrorMessage

string

None.

InfoMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "ID": 1,
    "LocationID": 2,
    "RelatedTo": "sample string 3",
    "SequenceValue": {
      "NextNumberShouldBe": 1,
      "Suffix": "sample string 2",
      "Prefix": "sample string 3"
    }
  },
  "CreatedBy": "sample string 1",
  "EntityID": 2,
  "RowSource": "sample string 3",
  "PolicyID": 4,
  "IsSuccess": true,
  "ErrorCode": "sample string 6",
  "ErrorMessage": "sample string 7",
  "InfoMessage": "sample string 8"
}

application/xml, text/xml

Sample:
<ActionResultOfSequenceNumberDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 6</ErrorCode>
  <ErrorMessage>sample string 7</ErrorMessage>
  <InfoMessage>sample string 8</InfoMessage>
  <IsSuccess>true</IsSuccess>
  <CreatedBy>sample string 1</CreatedBy>
  <EntityID>2</EntityID>
  <PolicyID>4</PolicyID>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Locations">
    <d2p1:ID>1</d2p1:ID>
    <d2p1:LocationID>2</d2p1:LocationID>
    <d2p1:RelatedTo>sample string 3</d2p1:RelatedTo>
    <d2p1:SequenceValue>
      <d2p1:NextNumberShouldBe>1</d2p1:NextNumberShouldBe>
      <d2p1:Prefix>sample string 3</d2p1:Prefix>
      <d2p1:Suffix>sample string 2</d2p1:Suffix>
    </d2p1:SequenceValue>
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfSequenceNumberDTO>