Load usage transactions

post

https://{env}.gainsystems.com/api/v1/usage-transactions

Loads usage transactions into GAINS X: the quantities of items that work orders request and produce. One record holds the locations and dates its LineItems share. Records that pass validation are loaded asynchronously; follow the returned task. See Inventory & Supply.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

IdealLocationCode

string

required

length between 1 and 80

Ideal location where the transaction is expected to occur

ActualLocationCode

string

required

length between 1 and 80

Actual location where the transaction takes place

RequestDate

date

required

Required. Date when the request for the transaction is made (YYYY-MM-DD)

OrderEntryDate

date

required

Required. Date when the order is entered into the system (YYYY-MM-DD)

LotNumber

string

length between 0 and 20

Lot number associated with the transaction

LineItems

array of objects

required

length ≥ 1

The line items belonging to this usage transaction

LineItems*

The line items belonging to this usage transaction

ItemCode

string

required

length between 1 and 65

Part number or SKU code for the item

PromiseDate

date

required

Required. Date when the item is promised to be available or fulfilled (YYYY-MM-DD)

OrderReleaseDate

date

required

Required. Date when the order is released for processing or manufacturing (YYYY-MM-DD)

RequestedQuantity

int32

required

≥ 0

Quantity of the item requested

ProducedQuantity

int32

required

≥ 0

Quantity of the item produced

WorkOrderNumber

string

required

length between 1 and 12

Work order number associated with the item

WorkLineNumber

string

required

length between 1 and 8

Line number within the work order

WorkSplit

string

required

length between 1 and 2

Work split code or identifier

SalesOrderNumber

string

length between 0 and 12

Sales order number linked to the transaction

SalesLineNumber

string

length between 0 and 8

Line number within the sales order

SalesSplit

string

length between 0 and 2

Sales split code or identifier

Status

string

required

length between 1 and 2

Current status of the transaction

BTOKitItemCode

string

length between 0 and 65

Build-to-Order (BTO) kit item code

BTOKitLocationCode

string

length between 0 and 80

Build-to-Order (BTO) kit location code

ExcludeFlag

boolean

Flag indicating whether the item should be excluded from processing or forecasting

ActualItemNumber

string

length between 0 and 65

Actual item number or identifier used for reference

Headers

Idempotency-Key

string

length ≤ 255

Optional key that makes a retry safe. A request repeating a key already used on this endpoint within the last 24 hours is refused with 400 and nothing is submitted again. A UUID is recommended; at most 255 characters

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/json

202Accepted; poll the returned task for progress

207Partially accepted; rejected records are listed in the response

400Malformed request, unknown field, or failed validation

401Credentials missing or not valid: a wrong user name or password, an invalid or expired token, or Basic credentials on an endpoint that accepts only a Bearer token

403Your credentials do not have the permission this endpoint requires, or the GAINS X connection is not enabled for your environment

422Nothing was accepted and no task was created. Either every record failed validation, and the body lists each one under RejectedRecords with Status "RejectedFailedProcessing"; or the payload was empty or held more than 1000 records, and the body carries a Reason

426The connected GAINS X version does not support this endpoint. The body states the current version and the version required

429The service is still ingesting previously submitted data and did not accept this batch. Nothing was persisted; retry the same batch after the interval given in the Retry-After header

500Unexpected server error

503GAINS is temporarily unavailable, or inbound integration is switched off in GAINS X: GAINS X could not be reached or returned an error, or your credentials could not be checked. Retry later, or contact your GAINS representative if inbound integration is not enabled

504GAINS X did not respond in time. Retry later