Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/CodexaCP/DG_WEB/llms.txt

Use this file to discover all available pages before exploring further.

The Receipts API exposes ReceivingHeaders — the primary document type for inbound inventory in Dragon Guard WMS. From the web frontend, users can list existing receipt headers, inspect a single receipt, and create new receipt documents. The physical receiving process (scanning items, incrementing quantityReceived) and the final posting step are performed exclusively by warehouse handheld devices; both operations are forbidden from the web client.

​
Endpoints overview

MethodPathDescription
GET/api/ReceivingHeadersList all receipt headers for a company
GET/api/ReceivingHeaders/{id}Retrieve a single receipt header by ID
POST/api/ReceivingHeadersCreate a new receipt header document

​
List receipt headers

GET /api/ReceivingHeaders?companyId={companyId}
Authorization: Bearer {token}
Returns a paginated list of ReceivingHeader documents belonging to the specified company.

​
Query parameters

​
companyId
number
required
The ID of the active company. Must match the active_company_id stored in sessionStorage for tenant users.
Example response 
[
  {
    "id": 101,
    "documentNo": "RCV-2024-0041",
    "vendorId": 5,
    "expectedDate": "2024-07-15",
    "quantityExpected": 200,
    "quantityReceived": 0,
    "status": "Open",
    "companyId": 7
  }
]

​
Get receipt header by ID

GET /api/ReceivingHeaders/{id}
Authorization: Bearer {token}

​
Path parameters

​
id
number
required
The unique identifier of the ReceivingHeader document.
Example response 
{
  "id": 101,
  "documentNo": "RCV-2024-0041",
  "vendorId": 5,
  "vendorName": "Distribuidora Norte S.A.",
  "expectedDate": "2024-07-15",
  "quantityExpected": 200,
  "quantityReceived": 0,
  "lines": [],
  "status": "Open",
  "companyId": 7,
  "createdAt": "2024-07-10T09:22:00Z"
}

​
Create a receipt header

POST /api/ReceivingHeaders
Authorization: Bearer {token}
Content-Type: application/json
Creates a new inbound document in Open status. The document number is assigned by the backend sequence; use GET /api/document-sequence only for an informational preview in the UI.

​
Request body

​
companyId
number
required
The ID of the company this receipt belongs to.
​
vendorId
number
required
The ID of the vendor from whom the goods are being received.
​
expectedDate
string
required
ISO 8601 date string representing the expected arrival date (YYYY-MM-DD).
​
quantityExpected
number
required
Total number of units expected for this receipt document.
​
quantityReceived
number
required
Must be 0 at creation. Physical receiving is performed by handheld devices only.
​
purchaseOrderId
number
Optional reference to an existing purchase order. Links the receipt to the corresponding order flow.
​
lines
array
Array of line items to include on the receipt. Each line references an item and an expected quantity.
Example request 
{
  "companyId": 7,
  "vendorId": 5,
  "expectedDate": "2024-07-20",
  "quantityExpected": 150,
  "quantityReceived": 0,
  "lines": [
    { "itemId": 88, "quantityExpected": 100, "unitOfMeasure": "BOX" },
    { "itemId": 92, "quantityExpected": 50,  "unitOfMeasure": "EA"  }
  ]
}
Example response — 201 Created 
{
  "id": 102,
  "documentNo": "RCV-2024-0042",
  "status": "Open",
  "companyId": 7,
  "vendorId": 5,
  "quantityExpected": 150,
  "quantityReceived": 0,
  "createdAt": "2024-07-12T14:05:00Z"
}

​
Business rules

Forbidden from the web client: POST /api/ReceivingHeaders/{id}/post must never be called from the Dragon Guard WMS Angular frontend. Posting a receipt document is a privileged operation reserved exclusively for warehouse handheld devices. Any attempt to expose this action in the web UI is a critical implementation error.
quantityReceived must always be 0 when creating a receipt header. The backend will reject any creation request where this field is non-zero. Quantities are updated incrementally by the handheld receiving flow.
  • All receipt documents are scoped to a single company via companyId.
  • Document numbers are generated by the backend sequence — never reuse or predict sequence values.
  • Vendors referenced by vendorId must exist and belong to the same companyId.
  • Lines referencing items (itemId) must correspond to active items in the company’s catalog.

​
Error codes

HTTP StatusMeaning
400Validation error — quantityReceived ≠ 0, missing fields, invalid references
401Missing or expired JWT token
500Internal server error

Build docs developers (and LLMs) love

Get started for freeTalk to us