Jump to

• Request
• Response

Get one B2B account number

get

/fscmRestApi/resources/11.13.18.05/b2bAccountNumbers/{AccountNumberId}

Request

Path Parameters

• AccountNumberId(required): integer(int64)
  Unique identifier of the B2B account number. This value is derived.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : b2bAccountNumbers-item-response

Type: object

Show Source

• AccountNumber: string
  Maximum Length: 256

  Identifier of the B2B account number.
• AccountNumberId: integer (int64)
  Unique identifier of the B2B account number. This value is derived.
• BillToBU: integer (int64)
  Unique identifier of the business unit that's used to create the invoice during message processing. This value is derived.
• BillToBUName: string
  Maximum Length: 255

  Name of the business unit that's used to create the invoice during message processing.
• ExternalPartnerId: integer (int64)
  Unique identifier of the trading partner. This is a foreign key to CMK_EXTERNAL_PARTNERS. This value is derived.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaySite: string
  Maximum Length: 255

  Name of the site used to create the invoice during message processing.
• PaySiteId: integer (int64)
  Unique identifier of the site that's used to create the invoice during message processing. This value is derived.
• ProcurementBU: string
  Maximum Length: 255

  Name of the procurement business unit where the supplier site resides. This value is required if account numbers are setup at the site level.
• ServiceProviderId: integer (int64)
  Unique identifier of the service provider. This value is derived.
• ServiceProviderName: string
  Maximum Length: 255

  Name of the service provider. This is a required field.
• shipToAssignments: array Ship-To Assignments
  Title: Ship-To Assignments

  The shipToLocation resource is used to manage the list of ship-to locations that are associated with a B2B account number.
• SiteName: string
  Maximum Length: 255

  Supplier site name. This value is required if account numbers are set up at the site level.
• SPUserDefined: string
  Maximum Length: 255

  Mark that indicates whether the service provider is user-defined or not. This is a required field.
• SupplierName: string
  Maximum Length: 255

  Supplier name. This value is derived.
• SupplierNumber: string
  Maximum Length: 255

  Number that identifies the supplier. This value is required.
• TradingPartnerId: string
  Maximum Length: 255

  Identifier of the trading partner. This attribute is required.
• TradingPartnerIdType: string
  Maximum Length: 255

  Type of identifier of the trading partner. This attribute is required.
• VendorId: integer (int64)
  Unique identifier of the supplier. This value is derived.
• VendorSiteId: integer (int64)
  Unique identifier of the supplier site. This value is derived.

{
    "type":"object",
    "properties":{
        "SPUserDefined":{
            "maxLength":255,
            "type":"string",
            "description":"Mark that indicates whether the service provider is user-defined or not. This is a required field.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBU":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the procurement business unit where the supplier site resides. This value is required if account numbers are setup at the site level.",
            "nullable":true,
            "x-queryable":true
        },
        "TradingPartnerId":{
            "maxLength":255,
            "type":"string",
            "description":"Identifier of the trading partner. This attribute is required.",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceProviderName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the service provider. This is a required field.",
            "nullable":true,
            "x-queryable":true
        },
        "SiteName":{
            "maxLength":255,
            "type":"string",
            "description":"Supplier site name. This value is required if account numbers are set up at the site level.",
            "nullable":true,
            "x-queryable":true
        },
        "shipToAssignments":{
            "title":"Ship-To Assignments",
            "type":"array",
            "description":"The shipToLocation resource is used to manage the list of ship-to locations that are associated with a B2B account number.",
            "items":{
                "$ref":"#/components/schemas/b2bAccountNumbers-shipToAssignments-item-response"
            }
        },
        "ServiceProviderId":{
            "type":"integer",
            "description":"Unique identifier of the service provider. This value is derived.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaySite":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the site used to create the invoice during message processing.",
            "nullable":true,
            "x-queryable":true
        },
        "VendorId":{
            "type":"integer",
            "description":"Unique identifier of the supplier. This value is derived.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternalPartnerId":{
            "type":"integer",
            "description":"Unique identifier of the trading partner. This is a foreign key to CMK_EXTERNAL_PARTNERS. This value is derived.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaySiteId":{
            "type":"integer",
            "description":"Unique identifier of the site that's used to create the invoice during message processing. This value is derived.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the supplier. This value is required.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountNumber":{
            "maxLength":256,
            "type":"string",
            "description":"Identifier of the B2B account number. ",
            "nullable":false,
            "x-queryable":true
        },
        "TradingPartnerIdType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of identifier of the trading partner. This attribute is required.",
            "nullable":true,
            "x-queryable":true
        },
        "VendorSiteId":{
            "type":"integer",
            "description":"Unique identifier of the supplier site. This value is derived.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillToBU":{
            "type":"integer",
            "description":"Unique identifier of the business unit that's used to create the invoice during message processing. This value is derived.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":255,
            "type":"string",
            "description":"Supplier name. This value is derived.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccountNumberId":{
            "type":"integer",
            "description":"Unique identifier of the B2B account number. This value is derived.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "BillToBUName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the business unit that's used to create the invoice during message processing.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Ship-To Assignments

Type: array

Title: Ship-To Assignments

The shipToLocation resource is used to manage the list of ship-to locations that are associated with a B2B account number.

Show Source

• Array of: object b2bAccountNumbers-shipToAssignments-item-response

{
    "title":"Ship-To Assignments",
    "type":"array",
    "description":"The shipToLocation resource is used to manage the list of ship-to locations that are associated with a B2B account number.",
    "items":{
        "$ref":"#/components/schemas/b2bAccountNumbers-shipToAssignments-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : b2bAccountNumbers-shipToAssignments-item-response

Type: object

Show Source

• AccountNumberId: integer (int64)
  Unique identifier of the B2B account number. This is a foreign key to the cmk account numbers table.
• Address: string
  Maximum Length: 255

  Address of the ship-to location.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Set: string
  Maximum Length: 255

  Code of the set to which the location belongs, for example, common set.
• ShipToAssignmentId: integer (int64)
  Unique identifier for the Ship to Location Assignment. Its value is an application-generated unique ID.
• ShipToLocationCode: string
  Maximum Length: 255

  Ship-to location code. This is a required field.
• ShipToLocationId: integer (int64)
  Unique identifier of the ship-to location. This value is derived.

{
    "type":"object",
    "properties":{
        "ShipToLocationId":{
            "type":"integer",
            "description":"Unique identifier of the ship-to location. This value is derived.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Set":{
            "maxLength":255,
            "type":"string",
            "description":"Code of the set to which the location belongs, for example, common set.",
            "nullable":true,
            "x-queryable":true
        },
        "Address":{
            "maxLength":255,
            "type":"string",
            "description":"Address of the ship-to location.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToAssignmentId":{
            "type":"integer",
            "description":"Unique identifier for the Ship to Location Assignment. Its value is an application-generated unique ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipToLocationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Ship-to location code. This is a required field.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccountNumberId":{
            "type":"integer",
            "description":"Unique identifier of the B2B account number. This is a foreign key to the cmk account numbers table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

shipToAssignments

Operation: /fscmRestApi/resources/11.13.18.05/b2bAccountNumbers/{AccountNumberId}/child/shipToAssignments

Parameters:

• AccountNumberId: $request.path.AccountNumberId

The shipToLocation resource is used to manage the list of ship-to locations that are associated with a B2B account number.

Back to Top