Get One New Vendor Request

Syntax

GET /api/new-vendor-requests/{id}/details/

Returns a JSON object that contains all core and custom fields for a new vendor request identified by its {id}. The user performing this API call has to be authorized to View New Vendor Requests.

Example:

GET /api/new-vendor-requests/20100/details/

Request Parameters

ParameterTypeDescriptionExample
idNumberNew vendor request identifierGET /api/new-vendor-requests/20100/details/ will return all core and custom fields for the new vendor request 20100.

Sample Response

An example JSON response can be seen here:

{
  "id": 19657,
  "ts": "2023-01-11T15:06:45.288495-05:00",
  "status_ts": "2023-01-11T15:08:03.662607-05:00",
  "request_status": "Approved",
  "request_type": "Partial",
  "is_resubmitted": false,
  "last_submitted_ts": "2023-01-11T15:06:45.285381-05:00",
  "exported_ts": "2023-01-11T15:57:53.467515-05:00",
  "num_submits": 1,
  "ip_address": null,
  "requested_by": 18512,
  "customer": 12589,
  "matched_supplier": null,
  "requesting_company": {
    "uei": "",
    "legal_last_name": "",
    "telephone": "+12023334445",
    "legal_first_name": "",
    "id": 12593,
    "validated_tin_type_status_code": -1,
    "remittance_addresses": [
      {
        "street1": "23000 Chambourcin Pl",
        "company": 12593,
        "zipcode": "20148-1809",
        "validated": true,
        "id": 44760,
        "city": "Ashburn",
        "name": "The court address",
        "created": "2023-01-11T20:06:29.934690Z",
        "bank_acct": null,
        "iso_3166_2": "US-VA",
        "pay_to": "Home Depot",
        "modified": "2023-01-11T20:06:29.934746Z",
        "state": "VA",
        "country": "US",
        "address_type": "R",
        "street2": ""
      }
    ],
    "tin_type": 1,
    "tin_name_validation_status": "VALID",
    "tin": "123456789",
    "tax_country": "US",
    "logo_url": "https://sandbox-static.paymentworks.com/static/1-2499-00/img/generic-logo.png",
    "tax_classification": {
      "code": 1,
      "name": "C Corporation"
    },
    "description": "paint for repair",
    "validated_tin_type_status": "",
    "duns": "",
    "order_address": null,
    "desc": "paint for repair",
    "legal_name": "Home Depot of Wolcott",
    "name": "Home Depot",
    "url": "",
    "w8_w9": "https://sandbox.paymentworks.com/api/files/homedepot-15/private/w8-w9-homedepot-15_43x1ALD.pdf",
    "corp_address": {
      "city": "Wolcott",
      "address_type": "C",
      "name": "Corporate Address",
      "created": "2022-04-12T13:52:36.268532Z",
      "street1": "36 Blansfield Ln",
      "company": 12593,
      "iso_3166_2": "US-CT",
      "modified": "2023-01-11T15:54:26.564643Z",
      "zipcode": "06716-1639",
      "state": "CT",
      "country": "US",
      "street2": "",
      "validated": true,
      "id": 35404
    },
    "corporate_email": "goran.stojanov+homedepot@paymentworks.com",
    "w9_consent": true,
    "remit_address": {
      "street1": "23000 Chambourcin Pl",
      "company": 12593,
      "zipcode": "20148-1809",
      "validated": true,
      "id": 44760,
      "city": "Ashburn",
      "name": "The court address",
      "created": "2023-01-11T20:06:29.934690Z",
      "bank_acct": null,
      "iso_3166_2": "US-VA",
      "pay_to": "Home Depot",
      "modified": "2023-01-11T20:06:29.934746Z",
      "state": "VA",
      "country": "US",
      "address_type": "R",
      "street2": ""
    }
  },
  "submission_data": 22881,
  "pending_registration": null,
  "bank_verification_reason_notes": null,
  "bank_verification_reason_contexts": null,
  "bank_verification_reasons": null,
  "invitation": null,
  "invite_data_files": [],
  "onboarding_supplier_name": null,
  "onboarding_tracker_path": null,
  "custom_fields": [],
  "custom_field_entries": [],
  "pending_final_approval": false,
  "tin_collisions": {},
  "approval_warnings": {},
  "op_code": "new_address",
  "related_vendor_number": "12345",
  "routing_annotation": "",
  "related_site_code": "2",
  "routing_enabled": true,
  "comments": [],
  "can_add_comments": true,
  "tags": []
}

JSON Response Key/Value Explanations

KeyTypeSample ValueDescription
idNumber20100
request_statusNumberApprovedCurrent status of the New Vendor Request. Possible values are:

  • Pending
  • Approved
  • Processed
  • Connected
  • Rejected
  • Returned

request_typeNumber
related_vendor_numberString
related_site_codeString

HTTP Response Codes

Status CodeDescription
200 OKThe request was processed successfully.
400 Bad RequestThe request could not be understood by the server due to incorrect syntax.
401 Unauthenticated
The request requires user authentication information. Your API token is missing or invalid.
403 ForbiddenPermission Denied – User does not have permission to perform this request
404 Not FoundThe resource you requested on the server does not exist
500The request has failed due to a temporary failure of the server. You can try this request at a later time.
503The request has failed due to a temporary failure of the server. You can try this request at a later time.

Calling the API

Call Syntax:

{
	"name": "get_one_nvr",
	"request": {
		"auth": {
			"type": "apikey",
			"apikey": [
				{
					"key": "value",
					"value": "Token 500aXXXXXXXXXXXXXXXXXXXX6b1cf",
					"type": "string"
				},
				{
					"key": "key",
					"value": "Authorization",
					"type": "string"
				}
			]
		},
		"method": "GET",
		"header": [],
		"url": {
			"raw": "https://sandbox.paymentworks.com/api/new-vendor-requests/7049117/details/",
			"protocol": "https",
			"host": [
				"sandbox",
				"paymentworks",
				"com"
			],
			"path": [
				"api",
				"new-vendor-requests",
				"7049117",
				"details"
			]
		}
	},
	"response": []
},

Sample PostMan call: