Retrieve Specific Business Partners by Code

20 Mar 2024
2 Minutes to read

Print
Dark
Light

Retrieve Specific Business Partners by Code

Updated on 20 Mar 2024
2 Minutes to read

Print
Dark
Light

Article Summary

Share feedback

Thanks for sharing your feedback!

Get

/sys-rest-api/rest/1/businesspartner

Query Standards

Finder

Following row finders are available for data filtering and optimizing request performance.

Select by Business Partner
Select by Audit Date
By UUID

Select by Business Partner

Recommended finder parameters. Refer to Query Parameters for example.

Parameter	Description	Sample
businessPartner	Business Partner Code	AGO

Select by Audit Date

This is an optional finder for querying Business Partners by Audit Date.

Parameter	Description	Sample
auditDate	create or update date time filter	2022-12-20

By UUID

This is an optional finder for querying a specific Business Partner by row ID.

Parameter	Description	Sample
/VUUID	The VUuid attribute is the Unique row ID	/sys-rest-api/rest/1/businesspartner/AC6B64BFDB14979DE053B08610ACC528

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExampleselectBusinessPartner;businessPartner=AGO

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

Exampletrue

orderBy

string

ExampleBpCode:desc

Responses

200

Headers

Content-Type

string

example-0

Successful Response - Finder - selectBusinessPartner

{
  "items": [
    {
      "Bp1099Code": "X",
      "Bp1099Name": "Exempt",
      "BpAbbrevCode": "AGO",
      "BpActiveFlag": "Y",
      "BpAdd1": "317 Dundas St. W",
      "BpAdd2": null,
      "BpAdd3": "Toronto",
      "BpAkaName": "Art Gallery of Ontario",
      "BpClassCode": null,
      "BpClassName": null,
      "BpClvValueCode1": null,
      "BpClvValueCode1Prompt": null,
      "BpClvValueCode2": null,
      "BpClvValueCode2Prompt": null,
      "BpClvValueCode3": null,
      "BpClvValueCode3Prompt": null,
      "BpClvValueCode4": null,
      "BpClvValueCode4Prompt": null,
      "BpClvValueCode5": null,
      "BpClvValueCode5Prompt": null,
      "BpClvValueCode6": null,
      "BpClvValueCode6Prompt": null,
      "BpCode": "AGO",
      "BpContactName": null,
      "BpCountry": "Canada",
      "BpCreateDefaultCustComp": "        ",
      "BpCreateDefaultVendorComp": "        ",
      "BpCustBalAmt": 0,
      "BpCustomerStatusFlag": "Y",
      "BpDispatchFlag": "N",
      "BpEmail": null,
      "BpFax": "416-555-9999",
      "BpLegalName": "Art Gallery of Ontario Ltd.",
      "BpLegalentTypeCode": "CHAR",
      "BpLegalentTypeName": "Charity/Non Profit",
      "BpModFlag": null,
      "BpName": "Art Gallery of Ontario",
      "BpOmOnlyFlag": "N",
      "BpOneTimeFlag": "N",
      "BpParentCode": null,
      "BpParentName": null,
      "BpPhone": "416-555-1212",
      "BpPostalCode": "M6T 2Y7",
      "BpPrequalRequiredFlag": "N",
      "BpRegionCode": "ON",
      "BpRegionName": "Ontario",
      "BpRegistrationCode": "127309837",
      "BpShortName": "Art Gallery of ",
      "BpSsnFlag": "N",
      "BpStartDate": "2014-12-31T00:00:00",
      "BpSysBpAutoNumberFlag": "N",
      "BpTypeCode": "P",
      "BpUeValidFlag": "Y",
      "BpVUuid": "AC6B64BFDB14979DE053B08610ACC528",
      "BpVatCountryCode": null,
      "BpVatRegistrationNum": null,
      "BpVendorStatusFlag": "N",
      "BpWebSite": null,
      "BpIuCreateDate": "2015-04-08T19:12:10Z",
      "BpIuUpdateDate": "2016-08-08T14:57:56Z",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/sys-rest-api/rest/1/businesspartner/AC6B64BFDB14979DE053B08610ACC528",
          "name": "businesspartner",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/sys-rest-api/rest/1/businesspartner/AC6B64BFDB14979DE053B08610ACC528",
          "name": "businesspartner",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/sys-rest-api/rest/1/businesspartner",
      "name": "businesspartner",
      "kind": "collection"
    }
  ]
}

example-1

Successful Response - Finder - selectByDate

{
  "items": [
    {
      "Bp1099Code": "X",
      "Bp1099Name": "Exempt",
      "BpAbbrevCode": "AGO",
      "BpActiveFlag": "Y",
      "BpAdd1": "317 Dundas St. W",
      "BpAdd2": null,
      "BpAdd3": "Toronto",
      "BpAkaName": "Art Gallery of Ontario",
      "BpClassCode": null,
      "BpClassName": null,
      "BpClvValueCode1": null,
      "BpClvValueCode1Prompt": null,
      "BpClvValueCode2": null,
      "BpClvValueCode2Prompt": null,
      "BpClvValueCode3": null,
      "BpClvValueCode3Prompt": null,
      "BpClvValueCode4": null,
      "BpClvValueCode4Prompt": null,
      "BpClvValueCode5": null,
      "BpClvValueCode5Prompt": null,
      "BpClvValueCode6": null,
      "BpClvValueCode6Prompt": null,
      "BpCode": "AGO",
      "BpContactName": null,
      "BpCountry": "Canada",
      "BpCreateDefaultCustComp": "        ",
      "BpCreateDefaultVendorComp": "        ",
      "BpCustBalAmt": 0,
      "BpCustomerStatusFlag": "Y",
      "BpDispatchFlag": "N",
      "BpEmail": null,
      "BpFax": "416-555-9999",
      "BpLegalName": "Art Gallery of Ontario Ltd.",
      "BpLegalentTypeCode": "CHAR",
      "BpLegalentTypeName": "Charity/Non Profit",
      "BpModFlag": null,
      "BpName": "Art Gallery of Ontario",
      "BpOmOnlyFlag": "N",
      "BpOneTimeFlag": "N",
      "BpParentCode": null,
      "BpParentName": null,
      "BpPhone": "416-555-1212",
      "BpPostalCode": "M6T 2Y7",
      "BpPrequalRequiredFlag": "N",
      "BpRegionCode": "ON",
      "BpRegionName": "Ontario",
      "BpRegistrationCode": "127309837",
      "BpShortName": "Art Gallery of ",
      "BpSsnFlag": "N",
      "BpStartDate": "2014-12-31T00:00:00",
      "BpSysBpAutoNumberFlag": "N",
      "BpTypeCode": "P",
      "BpUeValidFlag": "Y",
      "BpVUuid": "AC6B64BFDB14979DE053B08610ACC528",
      "BpVatCountryCode": null,
      "BpVatRegistrationNum": null,
      "BpVendorStatusFlag": "N",
      "BpWebSite": null,
      "BpIuCreateDate": "2015-04-08T19:12:10Z",
      "BpIuUpdateDate": "2016-08-08T14:57:56Z",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/businesspartner/AC6B64BFDB14979DE053B08610ACC528",
          "name": "businesspartner",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/businesspartner/AC6B64BFDB14979DE053B08610ACC528",
          "name": "businesspartner",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/businesspartner",
      "name": "businesspartner",
      "kind": "collection"
    }
  ]
}

object

What's Next

Retrieve a specific Business Partner

Retrieve Specific Business Partners by Code

Query Standards

Finder

Select by Business Partner

Select by Audit Date

By UUID

What's Next

Contact Us