inventory_bills_get_list
Retrieve a list of inventory bills by filtering with tenant ID, dates, job numbers, costs, or custom fields. Supports pagination and returns synced or failed records.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
batchId | No | Format - int64. | |
batchNumber | No | Format - int32. | |
billNumber | No | ||
businessUnitIds | No | ||
createdBefore | No | Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC) | |
createdOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC) | |
customField.Fields | No | Dictionary of name-value pairs | |
customField.Operator | No | Operator to be used between the name-value pairs. Can be "Or" or "And", default is "And". | |
dateFrom | No | Format - date-time (as date-time in RFC3339). | |
dateTo | No | Format - date-time (as date-time in RFC3339). | |
ids | No | ||
includeTotal | No | Whether total count should be returned | |
jobNumber | No | ||
maxCost | No | Format - decimal. | |
minCost | No | Format - decimal. | |
modifiedBefore | No | Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC) | |
modifiedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC) | |
page | No | Format - int32. The logical number of page to return, starting from 1 | |
pageSize | No | Format - int32. How many records to return (50 by default) | |
purchaseOrderNumber | No | ||
purchaseOrderTypes | No | ||
syncStatuses | No | ||
tenant | Yes | Format - int64. Tenant ID |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"batchId": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int64."
},
"batchNumber": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int32."
},
"billNumber": {
"type": [
"string",
"null"
]
},
"businessUnitIds": {
"type": [
"string",
"null"
]
},
"createdBefore": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC)"
},
"createdOnOrAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC)"
},
"customField.Fields": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Dictionary of name-value pairs"
},
"customField.Operator": {
"anyOf": [
{
"enum": [
"And",
"Or"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Operator to be used between the name-value pairs. Can be \"Or\" or \"And\", default is \"And\"."
},
"dateFrom": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339)."
},
"dateTo": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339)."
},
"ids": {
"type": [
"string",
"null"
]
},
"includeTotal": {
"description": "Whether total count should be returned",
"type": [
"boolean",
"null"
]
},
"jobNumber": {
"type": [
"string",
"null"
]
},
"maxCost": {
"description": "Format - decimal.",
"type": [
"number",
"null"
]
},
"minCost": {
"description": "Format - decimal.",
"type": [
"number",
"null"
]
},
"modifiedBefore": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC)"
},
"modifiedOnOrAfter": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"description": "Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC)"
},
"page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int32. The logical number of page to return, starting from 1"
},
"pageSize": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"description": "Format - int32. How many records to return (50 by default)"
},
"purchaseOrderNumber": {
"type": [
"string",
"null"
]
},
"purchaseOrderTypes": {
"type": [
"string",
"null"
]
},
"syncStatuses": {
"anyOf": [
{
"items": {
"enum": [
"New",
"SyncRequired",
"Syncing",
"Synced",
"Failed"
],
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
]
},
"tenant": {
"description": "Format - int64. Tenant ID",
"type": "integer"
}
},
"required": [
"tenant"
],
"type": "object"
}