On this page
addReceiptLines
mutation · in the family Inventory operations
What it does
Add more lines to a goods receipt you have not posted yet — the way a big delivery gets recorded.
APPEND lines to a DRAFT Receipt: the same per-line gates as create (the parent PO still RECEIVABLE, every poLineNo an existing PO line destined to THIS receipt's LF, a hold reason-coded, the pack pair variant-coherent); the DISTINCT (PO line × disposition) law holds over the WHOLE document (a key already on the receipt refuses VALIDATION/INVALID naming the holding lineNo); lineNo mints from the monotonic nextLineNo; the document total refuses past the ceiling. ONE transaction — the row Puts + the header rollups. A live post-draft doc refuses CONFLICT/REF_STATE. Requires the doc CURRENT revision (OCC) + the unrestricted capability. NO reason — the edit class.
What happens
Up to 90 lines per call; a receipt holds up to 1000. Each new line takes the next line number on the receipt; a number already used is never handed out again.
Careful
Only while the receipt is still a draft. One line per purchase-order line and routing — raise that line’s quantity instead of adding a second one.
Who may call it
Capability area: Inventory operations — Receiving, counting, transferring and moving stock.
- Owner
- Manager
- Associate Manager
- Warehouse Associate
- An API key whose scope allows
api:addReceiptLines
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
input | AddReceiptLinesInput AddReceiptLinesInput! | yes | No further notes. |
revision | ID ID! | yes | The revision id you read on the record; the change is refused if an edit landed in the meantime. |
Returns
Receipt Receipt! — Over-receipt refuses CONFLICT/THREE_WAY_MATCH (the PO declared receive.match_flag form; tolerance ZERO until); under-receipt is partial, first-class — the next receipt is a NEW doc. posted is the immutable NON-doomed fact (corrections are compensating movements, never edits); cancelled is the doomed terminal (lists filter it). Re-running post RESUMES a stalled walk; on a healthy in-flight receipt it refuses CONFLICT/IN_PROGRESS naming the progress; one receipt posts against a purchase order at a time (its receivingReceiptId).
Example request
mutation ExampleAddReceiptLines($input: AddReceiptLinesInput!, $revision: ID!) {
addReceiptLines(input: $input, revision: $revision) {
id
sysId
type
caption
status
parentId
rootId
createdAt
updatedAt
revisionNum
revision
logicalFacilityId
organizationId
lineCount
nextLineNo
}
}
Variables:
{
"input": {
"receiptId": "01900000-0000-7000-8000-458bf62e0000",
"lines": [
{
"poLineNo": 1,
"quantityReceived": "<quantity received>",
"disposition": "accept"
}
]
},
"revision": "01900000-0000-7000-8000-b7960e180000"
}
Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.
Example response
{
"data": {
"addReceiptLines": {
"id": "01900000-0000-7000-8000-37386ae00000",
"sysId": "RC-EXMP-0000-000F",
"type": "Receipt",
"caption": "Blue jeans",
"status": "draft",
"parentId": "01900000-0000-7000-8000-065235280000",
"rootId": "01900000-0000-7000-8000-a093dd800000",
"createdAt": "2027-01-31T00:00:00.000Z",
"updatedAt": "2027-01-31T00:00:00.000Z",
"revisionNum": 1,
"revision": "01900000-0000-7000-8000-b7960e180000",
"logicalFacilityId": "01900000-0000-7000-8000-8026f71c0000",
"organizationId": "01900000-0000-7000-8000-44b781470000",
"lineCount": 1,
"nextLineNo": 1
}
},
"extensions": {
"at": {
"callId": "01EXAMPLE-CALL-ID",
"version": {
"requested": {
"name": "genesis",
"number": 0
},
"serviced": {
"name": "genesis",
"number": 0
}
}
}
}
}
Errors this call can answer
VALIDATION/INVALID— Something in the request is not valid. (VALIDATION)AUTHN/REQUIRED— Sign in to do this. (AUTHN)AUTHZ/FORBIDDEN— Your role does not allow this action. (AUTHZ)RATE_LIMIT/THROTTLED— Too many requests in a short time. (RATE_LIMIT)NOT_FOUND/*— That record could not be found. (NOT_FOUND)CONFLICT/*— The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)VALIDATION/VERSION_REQUIRED— The request did not say which app version it came from. (VALIDATION)