API reference
- Getting Started with Your API
- SDKs and Toolkits
- Customer Overview
- GETGet Account Attributes
- POSTAdd Account Attribute
- GETGet Account Attribute
- PUTUpdate Account Attribute
- DELDelete Account Attribute
- GETGet Account Cards
- POSTAdd Account Card
- GETGet Account Card
- PUTUpdate Account Card
- DELDelete Account Card
- GETGet Account Contacts
- PUTAdd Account Contact List
- POSTAdd Account Contact
- GETGet Account Contact
- PUTUpdate Account Contact
- DELDelete Account Contact
- GETGet Accounts
- POSTAdd Account
- GETGet Account
- PUTUpdate Account
- DELDelete Account
- GETRetrieve Current Account
- GETGet Transactions
- POSTAdd Transaction
- DELRemove Transaction
- POSTRecompute Customer Lifetime Value
- GETGet Account Notes
- POSTAdd Account Note
- GETGet Account Note
- PUTUpdate Account Note
- DELDelete Account Note
- GETGet Account Segments
- GETGet Account Audit Log
- 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
- POSTGet Login State By UserName
- POSTGet Login State By Email Address
- GETGet Login State
- POSTChange Password
- POSTChange Passwords
- POSTReset Password
- POSTUpdate Forgotten Password
- POSTAdd Login To Existing Customer
- POSTAdd Account And Login
- POSTSet Login Locked
- POSTSet Password Change Required
- POSTAdd Accounts
- GET
A valid request URL is required to generate request examples{
"customerPurchaseOrderAccountId": 123,
"externalId": "<string>",
"siteId": 123,
"tenantId": 123,
"transactionDate": "2023-11-07T05:31:56Z",
"orderId": "<string>",
"purchaseOrderNumber": "<string>",
"transactionAmount": 123,
"creditLimit": 123,
"additionalTransactionDetail": "<string>",
"availableBalance": 123,
"transactionTypeId": 123,
"transactionDescription": "<string>",
"author": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
}Create Purchase Order Transaction
Creates a purchase order transaction log (for public api use).
A valid request URL is required to generate request examples{
"customerPurchaseOrderAccountId": 123,
"externalId": "<string>",
"siteId": 123,
"tenantId": 123,
"transactionDate": "2023-11-07T05:31:56Z",
"orderId": "<string>",
"purchaseOrderNumber": "<string>",
"transactionAmount": 123,
"creditLimit": 123,
"additionalTransactionDetail": "<string>",
"availableBalance": 123,
"transactionTypeId": 123,
"transactionDescription": "<string>",
"author": "<string>",
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
}
}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
Unique identifier for Customer purchase order account
Site Id associated with transaction log
Tenant Id associated with transaction log
Date when the transaction was made on a purchase order account
Unique identifier for an order
Purchase order number
Transaction amount in transaction log for a purchase order account
Maximum credit available on a purchase order account
Any additional transaction detail other than transaction description
Current available balance on Purchase Order account
Purchase Order transaction type 1 - Line of Credit Change 2 - Order Submitted 3 - Payment Collected 4 - Payment Voided 5 - Payment Refund 6 - Manual Adjustment
Purchase Order transaction description Line of Credit Change Order Submitted Payment Collected Payment Voided Payment Refund Manual Adjustment
Show child attributes
Show child attributes
Response
Success
Customer purchase order transaction log
Unique identifier for Customer purchase order account
Site Id associated with transaction log
Tenant Id associated with transaction log
Date when the transaction was made on a purchase order account
Unique identifier for an order
Purchase order number
Transaction amount in transaction log for a purchase order account
Maximum credit available on a purchase order account
Any additional transaction detail other than transaction description
Current available balance on Purchase Order account
Purchase Order transaction type 1 - Line of Credit Change 2 - Order Submitted 3 - Payment Collected 4 - Payment Voided 5 - Payment Refund 6 - Manual Adjustment
Purchase Order transaction description Line of Credit Change Order Submitted Payment Collected Payment Voided Payment Refund Manual Adjustment
Show child attributes
Show child attributes