Get Customer Purchase Order Account

Gets a customer’s purchase order account.

GET /commerce/customer/accounts/{accountId}/purchaseOrderAccount

Error

A valid request URL is required to generate request examples

200

{
  "accountId": 123,
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "availableBalance": 123,
  "creditLimit": 123,
  "customerPurchaseOrderPaymentTerms": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "code": "<string>",
      "description": "<string>",
      "siteId": 123
    }
  ],
  "id": 123,
  "isEnabled": true,
  "overdraftAllowance": 123,
  "overdraftAllowanceType": "<string>",
  "totalAvailableBalance": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

accountId · integer<int32> · required

Unique identifier of the account.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Success

accountId · integer<int32>

auditInfo · object

Show child attributes

availableBalance · number<double>

creditLimit · number<double>

customerPurchaseOrderPaymentTerms · object[] | null

Show child attributes

id · integer<int32>

isEnabled · boolean

overdraftAllowance · number<double> | null

overdraftAllowanceType · string | null

Indicates type of overdraft. Possible values are "Percent" and "Amount"

totalAvailableBalance · number<double>