API docs by Redocly

Asset Part Receival API (1.0.0)

Download OpenAPI specification:Download

URL: https://repzo.com

API for managing asset part receivals (receiving inventory)

Asset Part Receival

Operations related to asset part receival management

Get all asset part receivals

Retrieve a list of all asset part receivals with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new asset part receival

Create a new asset part receival with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
receivalNumber
required
string

Unique receival number

purchaseOrder
string

Purchase order reference

supplier
required
string

Supplier ID

receivalDate
required
string <date-time>

Date and time of receival

expectedDate
string <date-time>

Expected delivery date

receivedBy
string

User who received the parts

warehouse
string

Warehouse ID where parts were received

status
string
Default: "pending"
Enum: "pending" "partial" "complete" "cancelled"

Status of the receival

required
Array of objects
totalValue
number <double> >= 0

Total value of the receival

currency
string

Currency code

shippingCost
number <double> >= 0

Shipping cost

taxAmount
number <double> >= 0

Tax amount

discountAmount
number <double> >= 0

Discount amount

object
object
Array of objects
notes
string

General notes

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "receivalNumber": "RCV-2023-001",
  • "purchaseOrder": "PO-2023-001",
  • "supplier": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "receivalDate": "2023-01-15T10:00:00Z",
  • "expectedDate": "2023-01-14T10:00:00Z",
  • "receivedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "warehouse": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "status": "pending",
  • "items": [
    ],
  • "totalValue": 0,
  • "currency": "USD",
  • "shippingCost": 0,
  • "taxAmount": 0,
  • "discountAmount": 0,
  • "invoice": {
    },
  • "qualityCheck": {
    },
  • "documents": [],
  • "notes": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get asset part receival by ID

Retrieve a specific asset part receival by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part receival ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update asset part receival

Update an existing asset part receival with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part receival ID

Request Body schema: application/json
receivalNumber
required
string

Unique receival number

purchaseOrder
string

Purchase order reference

supplier
required
string

Supplier ID

receivalDate
required
string <date-time>

Date and time of receival

expectedDate
string <date-time>

Expected delivery date

receivedBy
string

User who received the parts

warehouse
string

Warehouse ID where parts were received

status
string
Default: "pending"
Enum: "pending" "partial" "complete" "cancelled"

Status of the receival

required
Array of objects
totalValue
number <double> >= 0

Total value of the receival

currency
string

Currency code

shippingCost
number <double> >= 0

Shipping cost

taxAmount
number <double> >= 0

Tax amount

discountAmount
number <double> >= 0

Discount amount

object
object
Array of objects
notes
string

General notes

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "receivalNumber": "RCV-2023-001",
  • "purchaseOrder": "PO-2023-001",
  • "supplier": "60f7b1b3e4b0e8b3f8b3f8b4",
  • "receivalDate": "2023-01-15T10:00:00Z",
  • "expectedDate": "2023-01-14T10:00:00Z",
  • "receivedBy": "60f7b1b3e4b0e8b3f8b3f8b5",
  • "warehouse": "60f7b1b3e4b0e8b3f8b3f8b6",
  • "status": "pending",
  • "items": [
    ],
  • "totalValue": 0,
  • "currency": "USD",
  • "shippingCost": 0,
  • "taxAmount": 0,
  • "discountAmount": 0,
  • "invoice": {
    },
  • "qualityCheck": {
    },
  • "documents": [],
  • "notes": "string",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete asset part receival

Delete an existing asset part receival

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Asset part receival ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Asset part receival deleted successfully"
}