Create a new adhoc inventory

post/adhoc-inventories
SecuritybearerAuth
Request
Request Body schema: application/json

New adhoc inventory

siteId
required
integer <int64>

Site identifier

name
required
string [ 1 .. 255 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Name

supplierAccountId
required
integer <int64>

Supplier account identifier

buyPrice
number

Buy price

sellPrice
required
number

Sell Price

billImmediately
boolean
Default: false

Bill immediately

isCredit
boolean
Default: false

Raise a credit note (requires billImmediately = true)

creditReason
string <= 255 characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Reason for credit

paid
boolean
Default: false

Is already paid?

paymentTerms
integer <int32>

Payment terms in days

paymentType
string (PaymentMethod)

Payment method

Enum: "CHEQUE" "DIRECT_DEBIT" "CANCELLED_DD" "CREDIT_CARD" "PAYPAL" "BACS" "POST_OFFICE_PAYMENT_CARD" "EZYPAY" "GO_CARDLESS" "GC_INSTANT_BANK_PAYMENTS" "STRIPE" "FINASTRA" "FAST_PAY" "OTHER"
quantity
required
number

Quantity

rentalProductCategoryId
required
integer <int64>

Rental product category Id

taxBandId
required
integer <int64>

Tax band identifier

nominalCode
string [ 1 .. 50 ] characters [a-zA-Z0-9\\p{L}.\\-_]*

Nominal code

Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

404

Not Found

412

Precondition Failed

500

Internal Server Error

501

Not Implemented Yet

Request samples
application/json
{
  • "siteId": 1,
  • "name": "string",
  • "supplierAccountId": 0,
  • "buyPrice": 0,
  • "sellPrice": 0,
  • "billImmediately": false,
  • "isCredit": false,
  • "creditReason": "string",
  • "paid": false,
  • "paymentTerms": 0,
  • "paymentType": "CHEQUE",
  • "quantity": 0,
  • "rentalProductCategoryId": 1,
  • "taxBandId": 1,
  • "nominalCode": "string"
}
Response samples
application/json
{
  • "id": 1,
  • "siteId": 1,
  • "name": "string",
  • "supplierAccountId": 0,
  • "buyPrice": 0,
  • "sellPrice": 0,
  • "billImmediately": false,
  • "isCredit": false,
  • "creditReason": "string",
  • "paid": false,
  • "paymentTerms": 0,
  • "paymentType": "CHEQUE",
  • "quantity": 0,
  • "rentalProductCategoryId": 1,
  • "taxBandId": 1,
  • "nominalCode": "string",
  • "billRunId": 1,
  • "adhocBillRunId": 1
}