API Reference
  1. Datagate Public API
  2. ProductTransactions

Creates a new one-off product transaction

post
https://api.dgportal.net/product-transactions

Creates a product transaction with the One-Off transaction type. cost and sell are calculated as unitCost quantity and unitSell quantity. When billingPeriod is not provided, the current billing period of the agreement is used.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
required
customer
object
required
agreement
object
site
object
siteZ
object
siteZCustomer
object

Must match customer. Requires siteZ.

service
object
supplier
object
glCode
object
productCategory
object
taxCode
object
billingPeriod
object

Required. When not provided on create, the current billing period of the agreement is used. Can't be changed on update.

transactionType
object

Only the One-Off transaction type (id = 1) is accepted.

serviceItems
array of objects
serviceItems
date-time
required

Can't be changed on update.

date-time | null

Can't be earlier than dateStart.

float
required
float
required
float
required
string | null
string | null
string | null
string | null
string | null
string | null
boolean

Only true is accepted.

boolean | null
boolean | null
boolean | null
Headers
string
required

A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Responses

Updated about 15 hours ago

Did this page help you?
Language
Credentials
Bearer
string token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 15 hours ago

Did this page help you?