Create Supplier

Post

POST /api/.../suppliers

Update supplier record. Pass in Dto containing the supplier data.

Request Information

Parameters
Name Type Required Description
DtoSupplierUpdate Supplier Yes Define this parameter in the request body.
DtoSupplierUpdate
Property Type Nullable Description
ElecCommFlag bool No The EDI Setup EDI Orders are accepted.
LBAcctNumber string Yes The Supplier Account.
RecordName string No The unique Alternative name assigned to the Supplier.
SupplierName string No The unique name assigned to the Supplier.
SupplierSAN string Yes The 7 character Supplier SAN, required when EDI orders accepted.
SupplierSANSuf string Yes The 5 character Supplier SAN Suffix, required when EDI orders accepted.
SupplierSANPre string Yes The 1 character Supplier SAN Prefix, required when EDI orders accepted.
OrganizationID string Yes The unique id assigned to the Organization.
Note string Yes Supplier Note
DiscRate decimal Yes Supplier Discount rate.
PlanNote string Yes Supplier Plan Note
MaxClaims int Yes Max claims
ClmWtPer1 int Yes Claim waiting period Days after release/expected arrival.
ClmWtPer2 int Yes Claim waiting period days after 1st claim.
ClmWtPer3 int Yes Claim waiting period days after 2nd claim.
ClmWtPer4 int Yes Claim waiting period days after 3rd claim.
ClmWtPer5 int Yes Claim waiting period days after 4th claim.
ClmNoticeInd bool Yes Claim notice indicator
CanNoticeInd bool Yes Cancel notice indicator
AutoCancelInd bool Yes Auto cancel indicator
CanWtPer int Yes Cancel wait period
DeliveryOptionID int Yes Delivery option for claim notice
CurrencyID int No Currency identifier
ExternalID string Yes Financial External ID
ClaimCP DtoContactPerson Yes Claim contact person
ClaimAddress DtoAddress Yes Claim address
OrderingCP DtoContactPerson Yes Ordering contact person
OrderingAddress DtoAddress Yes Ordering address
PaymentCP DtoContactPerson Yes Payment contact person
PaymentAddress DtoAddress Yes Payment address
ElectronicCommunications DtoElectronicCommunications Yes EDI Setup
MARCImportSchedules List of DtoMARCImportScheduleData Yes MARC Import Jobs/Schedules associated with this supplier.
DtoContactPerson
Property Type Nullable Description
ContactPersonID int No Contact Person ID
Name string Yes Contact Person name.
EmailAddress string Yes Contact Person email address.
PhoneNumberOne string Yes Contact Person phone number one.
PhoneNumberTwo string Yes Contact Person phone number two.
FaxNumber string Yes Contact Person fax number.
DtoAddress
Property Type Nullable Description
AddressID int No Address ID
PostalCodeID int Yes Postal Code ID.
PostalCode DtoPostalCode Yes Postal Code object.
StreetOne string Yes Address street one.
StreetTwo string Yes Address street two.
StreetThree string Yes Address street three.
ZipPlusFour string Yes Address zip plus four.
MunicipalityName string Yes Address municipality name.
DtoMARCImportScheduleData
Property Type Nullable Description
ImportJobID int Yes MARC Import Job ID
OrganizationID int No Owning Organization ID
ImportProfileID int No Import Profile ID
Address string No File access address
Username string No File access username
Password string No File access password
RemoteDirectory string Yes File access remote directory
ImportScheduleID int Yes MARC Import Schedule ID
FrequencyID int Yes Schedule frequency ID.
Accepts: null (Custom), 0 (Never), 1 (Continuously), 2 (Daily), 3 (Hourly)
CronExpression string Yes Schedule chronological expression, required when frequency is null (Custom)
FileExtension string Yes File access included file extension
StartTime TimeOnly Yes Starting time
EndTime TimeOnly Yes Starting time
IsEnabled bool No Is this schedule enabled?
Example
application/json, text/json 
  {
      "ElecCommFlag": true,
      "LBAcctNumber": null,
      "RecordName": "ts1",
      "SupplierName": "Test supplier 1",
      "SupplierSAN": "fffdsad",
      "SupplierSANSuf": null,
      "SupplierSANPre": null,
      "OrganizationID": 101,
      "Note": "general note",
      "DiscRate": 0,
      "PlanNote": "plan note",
      "MaxClaims": 3,
      "ClmWtPer1": 4,
      "ClmWtPer2": 5,
      "ClmWtPer3": 6,
      "ClmWtPer4": null,
      "ClmWtPer5": null,
      "ClmNoticeInd": true,
      "CanNoticeInd": false,
      "AutoCancelInd": false,
      "CanWtPer": null,
      "DeliveryOptionId": 2,
      "CurrencyID": 1,
      "ExternalID": "",
      "ClaimCP": {
        "ContactPersonID": 0,
        "Name": "tom smith",
        "EmailAddress": "test@iii.com",
        "PhoneNumberOne": null,
        "PhoneNumberTwo": null,
        "FaxNumber": null
      },
      "ClaimAddress": {
        "AddressID": 0,
        "PostalCodeID": 6473,
        "PostalCode": {
          "PostalCodeID": 6473,
          "Code": "13204",
          "City": "SYRACUSE",
          "State": "NY",
          "CountryID": 1,
          "County": "ONONDAGA"
        },
        "StreetOne": "123 abc",
        "StreetTwo": null,
        "StreetThree": null,
        "ZipPlusFour": null,
        "MunicipalityName": null
      },
      "OrderingCP": {
        "ContactPersonID": 0,
        "Name": "test name",
        "EmailAddress": null,
        "PhoneNumberOne": null,
        "PhoneNumberTwo": null,
        "FaxNumber": null
      },
      "OrderingAddress": {
        "AddressID": 0,
        "PostalCodeID": 6473,
        "PostalCode": {
          "PostalCodeID": 6473,
          "Code": "13204",
          "City": "SYRACUSE",
          "State": "NY",
          "CountryID": 1,
          "County": "ONONDAGA"
        },
        "StreetOne": "street one",
        "StreetTwo": null,
        "StreetThree": null,
        "ZipPlusFour": null,
        "MunicipalityName": null
      },
      "PaymentCP": {
        "ContactPersonID": 0,
        "Name": "",
        "EmailAddress": null,
        "PhoneNumberOne": null,
        "PhoneNumberTwo": null,
        "FaxNumber": null
      },
      "PaymentAddress": {
        "AddressID": 0,
        "PostalCodeID": 6473,
        "PostalCode": {
          "PostalCodeID": 6473,
          "Code": "13204",
          "City": "SYRACUSE",
          "State": "NY",
          "CountryID": 1
        },
        "StreetOne": "street one",
        "StreetTwo": null,
        "StreetThree": null,
        "ZipPlusFour": null,
        "MunicipalityName": null
      },
      "ElectronicCommunication": {
        "ElecCommID": 0,
        "SupplierID": null,
        "Address": "a",
        "Notes": null,
        "EnrichedEDI": true,
        "DefaultGetDir": "POA/INV directory",
        "DefaultPutDir": "PO directory",
        "POFileExt": "PO file ex",
        "FTPUserName": "b",
        "FTPPassword": "c",
        "ProfileTypeID": 1,
        "InterchangeCtrlNumber": 1,
        "GroupCtrlNumber": 1,
        "TransactionSetCtrlNumber": 1,
        "isbnflag": true,
        "ASNShipments": false
      },
      "MARCImportSchedules": [
        "ImportJobID": 14,
        "OrganizationID": 90,
        "ImportProfileID": 17,
        "Address": "ftp://ftp.test.com",
        "Username": "user",
        "Password": "fake",
        "RemoteDirectory": "/files",
        "ImportScheduleID": null,
        "FrequencyID": 1,
        "CronExpression": null,
        "FileExtension": "mrc",
        "StartTime": null,
        "EndTime": null,
        "IsEnabled": true
      ]
    }

Response Information

True is returned upon success.

Example
application/json, text/json 
true

HTTP Response Codes

Code Description
200 OK. Success
400 Bad request.