Get Buyer Business Unit Data

Describes the API specifications for retrieving all buyer business unit data.

Request

URI: https://<SAP Fieldglass envionment URL>/api/v1/admin/v1/buyer-business-units/<buyer-business-unitsID>?_loadInActiveObjects=true

HTTP Method: GET

Request Parameters

Parameter	Required	Data Type	Description	Parameter Type
buyer-business-unitID	Yes	String	The unique ID of the buyer business unit.	Path
?_loadInActiveObjects=true	No	String	Include a record that is inactive but should still be pulled into the API.	Query string

Request Example

GET https://company.com/api/v1/admin/v1/buyer-business-units/012504042814353939172072
authorization: Bearer WDXlKj3TTOn3rpg9GHnZpbKmvj1=
x-ApplicationKey: 5c91f4fdb0c6ee9992ff476f89bf6cf25e589350
content-type: application/json

Response

Response Status and Error Codes

See Common Status and Error Codes for more information.

Resonse Body

Response Payload Content

Element

Data Type

Description

activeFlag

Boolean

Indicates whether the business unit is active.

buCoordinatorDistributorSet

Array

Element	Data Type	Description
buId	String	The unique ID of the Buyer Business Unit.
coordinatorId	String	The unique ID of the Resource Coordinator.
distributorId	String	The unique ID of the Distributor.
mspCode	String	The company code for an MSP Business Unit.
requireCoordinatorFlag	Boolean	Indicates whether a Resource Coordinator is required for this Business Unit.
requireDistributorFlag	Boolean	Indicates whether a Distributor is required for this Business Unit.

buId

String

The unique ID of the Business Unit.

buyerSelectsAPCodeFlag

Boolean

Indicates whether the Business Unit has been configured to select the Accounts Payable (AP) code.

code

String

Code describing the Business Unit.

companyCode

String

The Business Unit's company code.

companyType

String

The Business Unit's company type.

coordinatorId

String

The unique ID of the Resource Coordinator.

createTime

String

The day and time the Business Unit record was created.

displayStatus

String

The Business Unit status that displays in the UI.

distributorId

String

The unique ID of the Distributor.

escalationPrefId

String

The Escalation Preference ID related to transactions that will be created for this Business Unit.

legalEntityAssociation

String

Indicates whether the business unit applies to more than one legal entity.

name

String

Name of the Business Unit.

parentBuId

String

The ID of the Business Unit directly above this Business Unit in the company Hierarchy.

requireCoordinatorFlag

Boolean

Indicates whether a Resource Coordinator is required for this Business Unit.

requireDistributorFlag

Boolean

Indicates whether a Distributor is required for this Business Unit.

requireRemitToAddressFlag

Boolean

Indicates ether a Remit-to Address is required.

revisionTime

String

The date and time the business unit record was revised.

uploadedFlag

Boolean

Response Payload Links
Element Name	Data Type	Description
rel	String	Related sub-modules. Example: self approval-groups billing-schedules custom-fields decision-form-templates distribution-lists job-templates offboarding-checklists onboarding-checklists pay-terms-templates rfx-templates users workers
link	String	The URI of the link.
id	String	Globally unique database-level identifier of the business unit record. Only valid when rel=self.

Response Example

Sample Code

Sample Response

{
    "header": {
        "server": "Fieldglass API Server",
        "responseStatus": "OK",
        "noOfRecordsPresent": 1,
        "noOfRecordsServed": 1,
        "moreRecordsExists": false,
        "localeString": "en_US",
        "version": "v1"
    },
    "responsePayload": {
        "content": {
            "activeFlag": true,
            "buCoordinatorDistributorSet": [
                {
                    "buId": "012504042814353939172072",
                    "coordinatorId": "012504042318065466407392",
                    "distributorId": "012504042318065466407392",
                    "mspCode": "ANTE",
                    "requireCoordinatorFlag": true,
                    "requireDistributorFlag": true
                }
            ],
            "buId": "012504042814353939172072",
            "buyerSelectsAPCodeFlag": false,
            "code": "Visibility",
            "companyCode": "ANTE",
            "companyType": "Buyer",
            "coordinatorId": "012504042318065466407392",
            "createTime": "08/06/2007 15:49",
            "displayStatus": "Active",
            "distributorId": "012504042318065466407392",
            "escalationPrefId": "012504111204461152503716",
            "legalEntityAssociation": "None",
            "name": "Visibility",
            "parentBuId": "012504042514212037309961",
            "requireCoordinatorFlag": true,
            "requireDistributorFlag": true,
            "requireRemitToAddressFlag": false,
            "revisionTime": "02/06/2009 01:44",
            "uploadedFlag": false
        },
        "links": [
            {
                "rel": "self",
                "link": "api/v1/admin/v1/buyer-business-units/012504042814353939172072",
                "id": "012504042814353939172072"
            },
            {
                "rel": "approval-groups",
                "link": "api/v1/admin/v1/buyer-business-units/012504042814353939172072/approval-groups"
            },
            {
                "rel": "billing-schedules",
                "link": "api/v1/admin/v1/buyer-business-units/012504042814353939172072/billing-schedules"
            },
            {
                "rel": "custom-fields",
                "link": "api/v1/admin/v1/buyer-business-units/012504042814353939172072/custom-fields"
            },
            {
                "rel": "decision-form-templates",
                "link": "api/v1/admin/v1/buyer-business-units/012504042814353939172072/decision-form-templates"
            },
            {
                "rel": "distribution-lists",
                "link": "api/v1/admin/v1/buyer-business-units/012504042814353939172072/distribution-lists"
            },
            {
                "rel": "job-templates",
                "link": "api/v1/admin/v1/buyer-business-units/012504042814353939172072/job-templates"
            },
            {
                "rel": "offboarding-checklists",
                "link": "api/v1/admin/v1/buyer-business-units/012504042814353939172072/offboarding-checklists"
            },
            {
                "rel": "onboarding-checklists",
                "link": "api/v1/admin/v1/buyer-business-units/012504042814353939172072/onboarding-checklists"
            },
            {
                "rel": "pay-terms-templates",
                "link": "api/v1/admin/v1/buyer-business-units/012504042814353939172072/pay-terms-templates"
            },
            {
                "rel": "rfx-templates",
                "link": "api/v1/admin/v1/buyer-business-units/012504042814353939172072/rfx-templates"
            },
            {
                "rel": "users",
                "link": "api/v1/admin/v1/buyer-business-units/012504042814353939172072/users"
            },
            {
                "rel": "workers",
                "link": "api/v1/admin/v1/buyer-business-units/012504042814353939172072/workers"
            }
        ]
    }
}