API reference
- Getting Started with Your API
- SDKs and Toolkits
- Customer Overview
- POSTAdd Account And Login
- POSTAdd Accounts
- POSTAdd Login To Existing Customer
- POSTChange Password
- POSTChange Passwords
- GETGet Account
- PUTUpdate Account
- DELDelete Account
- GETGet Account Attribute
- PUTUpdate Account Attribute
- DELDelete Account Attribute
- GETGet Account Attributes
- POSTAdd Account Attribute
- GETGet Account Audit Log
- GETGet Account Card
- PUTUpdate Account Card
- DELDelete Account Card
- GETGet Account Cards
- POSTAdd Account Card
- GETGet Account Contact
- PUTUpdate Account Contact
- DELDelete Account Contact
- GETGet Account Contacts
- PUTAdd Account Contact List
- POSTAdd Account Contact
- GETGet Account Note
- PUTUpdate Account Note
- DELDelete Account Note
- GETGet Account Notes
- POSTAdd Account Note
- GETGet Account Segments
- GETGet Accounts
- POSTAdd Account
- GETGet Customer Purchase Order Account
- PUTUpdate Customer Purchase Order Account
- POSTCreate Customer Purchase Order Account
- GETGet Customer Purchase Order Transactions
- POSTCreate Purchase Order Transaction
- POSTGet Customers Purchase Order Accounts
- GETGet Login State
- POSTGet Login State By Email Address
- POSTGet Login State By UserName
- GETGet Transactions
- POSTAdd Transaction
- POSTRecompute Customer Lifetime Value
- DELRemove Transaction
- POSTReset Password
- GETRetrieve Current Account
- POSTSet Login Locked
- POSTSet Password Change Required
- POSTUpdate Forgotten Password
A valid request URL is required to generate request examples{
"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
}Create Purchase Order Transaction
Creates a purchase order transaction log (for public api use).
A valid request URL is required to generate request examples{
"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
JWT Authorization header using the Bearer scheme.
Path Parameters
Unique identifier of the customer account.
Query Parameters
limits which fields are returned in the response body
Body
transaction log that needs to be created
Customer purchase order transaction log
Any additional transaction detail other than transaction description
Show child attributes
Show child attributes
Current available balance on Purchase Order account
Maximum credit available on a purchase order account
Unique identifier for Customer purchase order account
Unique identifier for an order
Purchase order number
Site Id associated with transaction log
Tenant Id associated with transaction log
Transaction amount in transaction log for a purchase order account
Date when the transaction was made on a purchase order account
Purchase Order transaction description Line of Credit Change Order Submitted Payment Collected Payment Voided Payment Refund Manual Adjustment
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
Success
Customer purchase order transaction log
Any additional transaction detail other than transaction description
Show child attributes
Show child attributes
Current available balance on Purchase Order account
Maximum credit available on a purchase order account
Unique identifier for Customer purchase order account
Unique identifier for an order
Purchase order number
Site Id associated with transaction log
Tenant Id associated with transaction log
Transaction amount in transaction log for a purchase order account
Date when the transaction was made on a purchase order account
Purchase Order transaction description Line of Credit Change Order Submitted Payment Collected Payment Voided Payment Refund Manual Adjustment
Purchase Order transaction type 1 - Line of Credit Change 2 - Order Submitted 3 - Payment Collected 4 - Payment Voided 5 - Payment Refund 6 - Manual Adjustment