Create Purchase Order Transaction

Creates a purchase order transaction log (for public api use).

POST /commerce/customer/accounts/{accountId}/PurchaseOrderTransaction

Error

A valid request URL is required to generate request examples

200

{
  "additionalTransactionDetail": "<string>",
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "author": "<string>",
  "availableBalance": 123,
  "creditLimit": 123,
  "customerPurchaseOrderAccountId": 123,
  "externalId": "<string>",
  "orderId": "<string>",
  "purchaseOrderNumber": "<string>",
  "siteId": 123,
  "tenantId": 123,
  "transactionAmount": 123,
  "transactionDate": "2023-11-07T05:31:56Z",
  "transactionDescription": "<string>",
  "transactionTypeId": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

accountId · integer<int32> · required

Unique identifier of the customer account.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Body

application/json

transaction log that needs to be created

Customer purchase order transaction log

additionalTransactionDetail · string | null

Any additional transaction detail other than transaction description

auditInfo · object

Show child attributes

author · string | null

availableBalance · number<double>

Current available balance on Purchase Order account

creditLimit · number<double>

Maximum credit available on a purchase order account

customerPurchaseOrderAccountId · integer<int32>

Unique identifier for Customer purchase order account

externalId · string | null

orderId · string | null

Unique identifier for an order

purchaseOrderNumber · string | null

Purchase order number

siteId · integer<int32>

Site Id associated with transaction log

tenantId · integer<int32>

Tenant Id associated with transaction log

transactionAmount · number<double>

Transaction amount in transaction log for a purchase order account

transactionDate · string<date-time>

Date when the transaction was made on a purchase order account

transactionDescription · string | null

Purchase Order transaction description Line of Credit Change Order Submitted Payment Collected Payment Voided Payment Refund Manual Adjustment

transactionTypeId · integer<int32>

Purchase Order transaction type 1 - Line of Credit Change 2 - Order Submitted 3 - Payment Collected 4 - Payment Voided 5 - Payment Refund 6 - Manual Adjustment

Response

200

application/json

Success

Customer purchase order transaction log

additionalTransactionDetail · string | null

Any additional transaction detail other than transaction description

auditInfo · object

Show child attributes

author · string | null

availableBalance · number<double>

Current available balance on Purchase Order account

creditLimit · number<double>

Maximum credit available on a purchase order account

customerPurchaseOrderAccountId · integer<int32>

Unique identifier for Customer purchase order account

externalId · string | null

orderId · string | null

Unique identifier for an order

purchaseOrderNumber · string | null

Purchase order number

siteId · integer<int32>

Site Id associated with transaction log

tenantId · integer<int32>

Tenant Id associated with transaction log

transactionAmount · number<double>

Transaction amount in transaction log for a purchase order account

transactionDate · string<date-time>

Date when the transaction was made on a purchase order account

transactionDescription · string | null

Purchase Order transaction description Line of Credit Change Order Submitted Payment Collected Payment Voided Payment Refund Manual Adjustment

transactionTypeId · integer<int32>

Purchase Order transaction type 1 - Line of Credit Change 2 - Order Submitted 3 - Payment Collected 4 - Payment Voided 5 - Payment Refund 6 - Manual Adjustment