FulcrumProduct.PublicApi (1.0)
Download OpenAPI specification:Download
Find accounting codes based on search parameters.
query Parameters
Sort.Field | string non-empty Sort field |
Sort.Dir | string (CommonEnumSortDirectionEnum) Enum: "ascending" "descending" Sort direction |
Skip | integer <int32> >= 0 Number of records to skip. |
Take | integer <int32> [ 0 .. 1000 ] Number of records to return (maximum) |
Request Body schema:
name | string or null [ 1 .. 200 ] characters Filter accounting codes based on their name. |
ids | Array of strings or null Filter accounting codes based on matching ids. |
Responses
Request samples
- Payload
{- "name": "string",
- "ids": [
- "string"
]
}
Response samples
- 200
[- {
- "id": "stringstringstringstring",
- "name": "string"
}
]
Create an attachment
Request Body schema: multipart/form-data
File required | string <binary> The file itself |
Detail.Owner.Type | string (CommonEnumOwnerTypeEnum) Enum: "salesOrder" "salesOrderPartLineItem" "quote" "quotePartLineItem" "purchaseOrder" "purchaseOrderPartLineItem" "invoice" "workOrderOperation" "operation" "inventoryLot" "item" "job" Owner types |
Detail.Owner.Id | string [ 24 .. 36 ] characters The primary owner id of this attachment. |
Detail.Description | string [ 1 .. 200 ] characters File description |
Detail.AttachmentType | string (CommonEnumAttachmentTypeEnum) Enum: "standard" "externalAccessDocument" "certification" Attachment types |
Detail.IsNoteAttachment required | boolean Indicates whether this attachment is bound to a note. |
Detail.Parent.Type | string (CommonEnumOwnerTypeEnum) Enum: "salesOrder" "salesOrderPartLineItem" "quote" "quotePartLineItem" "purchaseOrder" "purchaseOrderPartLineItem" "invoice" "workOrderOperation" "operation" "inventoryLot" "item" "job" Owner types |
Detail.Parent.Id | string [ 24 .. 36 ] characters The primary owner id of this attachment. |
object Metadata to associate to the attachment. |
Responses
Response samples
- 200
{- "id": "string"
}
Create an attachment based on a remote data endpoint.
Request Body schema:
required | object (AttachmentOwnerDto) Attachment owner |
fileName required | string [ 1 .. 200 ] characters File name |
accessUrl required | string <uri> non-empty File access url |
token | string or null Optional token that may be required for access the AccessUrl |
Responses
Request samples
- Payload
{- "owner": {
- "type": "salesOrder",
- "id": "stringstringstringstring"
}, - "fileName": "string",
- "token": "string"
}
Response samples
- 200
{- "id": "string"
}
Response samples
- 200
{- "id": "stringstringstringstring",
- "owner": {
- "type": "salesOrder",
- "id": "stringstringstringstring"
}, - "name": "string",
- "description": "string",
- "type": "standard",
- "format": "undefined",
- "size": 0,
- "fileId": "string"
}
Download attachment(s) for a given filter in ZIP format
query Parameters
fileName | string |
Request Body schema:
object (AttachmentOwnerDto) Attachment owner | |
attachmentIds | Array of strings or null [ 1 .. 500 ] items Filter to attachments whose ids are in the list. |
formats | Array of strings or null (CommonEnumAttachmentMediaFormatEnum) [ 1 .. 500 ] items Enum: "undefined" "cad" "document" "image" "video" Allows for filtering based on specific attachment format types. |
Responses
Request samples
- Payload
{- "owner": {
- "type": "salesOrder",
- "id": "stringstringstringstring"
}, - "attachmentIds": [
- "string"
], - "formats": [
- "undefined"
]
}
Find attachments based on search parameters.
query Parameters
Sort.Field | string non-empty Sort field |
Sort.Dir | string (CommonEnumSortDirectionEnum) Enum: "ascending" "descending" Sort direction |
Skip | integer <int32> >= 0 Number of records to skip. |
Take | integer <int32> [ 0 .. 1000 ] Number of records to return (maximum) |
Request Body schema:
object (AttachmentOwnerDto) Attachment owner | |
attachmentIds | Array of strings or null [ 1 .. 500 ] items Filter to attachments whose ids are in the list. |
formats | Array of strings or null (CommonEnumAttachmentMediaFormatEnum) [ 1 .. 500 ] items Enum: "undefined" "cad" "document" "image" "video" Allows for filtering based on specific attachment format types. |
Responses
Request samples
- Payload
{- "owner": {
- "type": "salesOrder",
- "id": "stringstringstringstring"
}, - "attachmentIds": [
- "string"
], - "formats": [
- "undefined"
]
}
Response samples
- 200
[- {
- "id": "stringstringstringstring",
- "owner": {
- "type": "salesOrder",
- "id": "stringstringstringstring"
}, - "name": "string",
- "description": "string",
- "type": "standard",
- "format": "undefined",
- "size": 0,
- "fileId": "string"
}
]
Response samples
- 200
{- "id": "stringstringstringstring",
- "isPrimary": true,
- "name": "string",
- "shipToAddress": {
- "name": "string",
- "address1": "string",
- "address2": "string",
- "address3": "string",
- "city": "string",
- "stateProvince": "string",
- "postalCode": "string",
- "country": "string"
}, - "remitToAddress": {
- "name": "string",
- "address1": "string",
- "address2": "string",
- "address3": "string",
- "city": "string",
- "stateProvince": "string",
- "postalCode": "string",
- "country": "string"
}, - "phoneNumber": "string",
- "faxNumber": "string",
- "email": "[email protected]"
}
Find company information based on search parameters.
query Parameters
Sort.Field | string non-empty Sort field |
Sort.Dir | string (CommonEnumSortDirectionEnum) Enum: "ascending" "descending" Sort direction |
Skip | integer <int32> >= 0 Number of records to skip. |
Take | integer <int32> [ 0 .. 1000 ] Number of records to return (maximum) |
Request Body schema:
isPrimary | boolean or null Filter on primary company info |
Responses
Request samples
- Payload
{- "isPrimary": true
}
Response samples
- 200
[- {
- "id": "stringstringstringstring",
- "isPrimary": true,
- "name": "string",
- "shipToAddress": {
- "name": "string",
- "address1": "string",
- "address2": "string",
- "address3": "string",
- "city": "string",
- "stateProvince": "string",
- "postalCode": "string",
- "country": "string"
}, - "remitToAddress": {
- "name": "string",
- "address1": "string",
- "address2": "string",
- "address3": "string",
- "city": "string",
- "stateProvince": "string",
- "postalCode": "string",
- "country": "string"
}, - "phoneNumber": "string",
- "faxNumber": "string",
- "email": "[email protected]"
}
]
Create a new customer
Request Body schema:
name required | string [ 1 .. 200 ] characters The name to give the customer. Must be unique to all active customers. |
customerCode | string or null non-empty Unique identifier for this customer |
currencyCode | string or null non-empty Currency code/denomination associated to this customer. If not provided, default to the primary currency code for the organization. |
creditLimit | number or null <double> >= 0 Credit limit |
paymentTermsId | string or null = 24 characters Payment terms. |
salesPersonId | string or null = 24 characters Payment terms. |
url | string or null <uri> The Customer's website |
isTaxable | boolean or null Whether or not this customer is taxable on Sales Orders and Quotes |
taxRateIds | Array of strings or null A list of tax codes to be automatically added to new SalesOrders for the customer when AutoAddTaxLineItems process setting is enabled. |
object or null Arbitrary key-value-pair like data that can be used to later on search for the customer | |
notes | string or null Notes associated to the customer. |
Responses
Request samples
- Payload
{- "name": "string",
- "customerCode": "string",
- "currencyCode": "string",
- "creditLimit": 0,
- "paymentTermsId": "stringstringstringstring",
- "salesPersonId": "stringstringstringstring",
- "isTaxable": true,
- "taxRateIds": [
- "string"
], - "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "notes": "string"
}
Response samples
- 200
{- "id": "string"
}
Response samples
- 200
{- "id": "stringstringstringstring",
- "name": "string",
- "customerCode": "string",
- "currencyCode": "string",
- "creditLimit": 0,
- "paymentTermsId": "stringstringstringstring",
- "salesPersonId": "stringstringstringstring",
- "isTaxable": true,
- "taxRateIds": [
- "string"
], - "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "customFields": {
- "property1": null,
- "property2": null
}, - "notes": "string"
}
Partially update a customer
path Parameters
customerId required | string = 24 characters |
Request Body schema: application/json-patch+json
op | string |
value | string |
path | string |
Responses
Request samples
- Payload
[- {
- "op": "string",
- "value": "string",
- "path": "string"
}
]
Response samples
- 200
{- "id": "stringstringstringstring",
- "name": "string",
- "customerCode": "string",
- "currencyCode": "string",
- "creditLimit": 0,
- "paymentTermsId": "stringstringstringstring",
- "salesPersonId": "stringstringstringstring",
- "isTaxable": true,
- "taxRateIds": [
- "string"
], - "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "customFields": {
- "property1": null,
- "property2": null
}, - "notes": "string"
}
Update a specific customer
path Parameters
customerId required | string = 24 characters |
Request Body schema:
name required | string [ 1 .. 200 ] characters The name to give the customer. Must be unique to all active customers. |
customerCode | string or null non-empty Unique identifier for this customer |
currencyCode | string or null non-empty Currency code/denomination associated to this customer. If not provided, default to the primary currency code for the organization. |
url | string or null <uri> The Customer's website |
creditLimit | number or null <double> >= 0 Credit limit |
paymentTermsId | string or null = 24 characters Payment terms identifier. Please reference /api/payment-terms endpoint. |
salesPersonId | string or null = 24 characters Sales person identifier. Please reference /api/users endpoint. |
isTaxable | boolean or null Whether or not this customer is taxable on Sales Orders and Quotes |
taxRateIds | Array of strings or null A list of tax codes to be automatically added to new SalesOrders for the customer when AutoAddTaxLineItems process setting is enabled. |
object or null Arbitrary key-value-pair like data that can be used to later on search for this line item. | |
notes | string or null Notes associated to the customer. |
Responses
Request samples
- Payload
{- "name": "string",
- "customerCode": "string",
- "currencyCode": "string",
- "creditLimit": 0,
- "paymentTermsId": "stringstringstringstring",
- "salesPersonId": "stringstringstringstring",
- "isTaxable": true,
- "taxRateIds": [
- "string"
], - "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "notes": "string"
}
Response samples
- 200
{- "id": "stringstringstringstring",
- "name": "string",
- "customerCode": "string",
- "currencyCode": "string",
- "creditLimit": 0,
- "paymentTermsId": "stringstringstringstring",
- "salesPersonId": "stringstringstringstring",
- "isTaxable": true,
- "taxRateIds": [
- "string"
], - "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "customFields": {
- "property1": null,
- "property2": null
}, - "notes": "string"
}
Find customers based on search parameters.
query Parameters
Sort.Field | string non-empty Sort field |
Sort.Dir | string (CommonEnumSortDirectionEnum) Enum: "ascending" "descending" Sort direction |
Skip | integer <int32> >= 0 Number of records to skip. |
Take | integer <int32> [ 0 .. 1000 ] Number of records to return (maximum) |
Request Body schema:
name | string or null [ 1 .. 200 ] characters Filter to customers who's name contains the given string |
customerCode | string or null non-empty Unique identifier for this customer. |
object (CommonExternalReferenceFindDto) Search parameter for identifier record(s) via their external identifiers. |
Responses
Request samples
- Payload
{- "name": "string",
- "customerCode": "string",
- "externalReference": {
- "key": "string",
- "type": "string",
- "externalId": "string"
}
}
Response samples
- 200
[- {
- "id": "stringstringstringstring",
- "name": "string",
- "customerCode": "string",
- "currencyCode": "string",
- "creditLimit": 0,
- "paymentTermsId": "stringstringstringstring",
- "salesPersonId": "stringstringstringstring",
- "isTaxable": true,
- "taxRateIds": [
- "string"
], - "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "customFields": {
- "property1": null,
- "property2": null
}, - "notes": "string"
}
]
Create a new customer address
path Parameters
customerId required | string = 24 characters |
Request Body schema:
name | string or null [ 1 .. 200 ] characters Name of the address (Bob's Shipping, Primary, Reno Warehouse, etc). |
address1 required | string [ 1 .. 200 ] characters Primary address line. |
address2 | string or null [ 1 .. 200 ] characters Second address line. |
address3 | string or null [ 1 .. 200 ] characters Third address line. |
city required | string [ 1 .. 200 ] characters Address city |
stateProvince | string or null [ 1 .. 200 ] characters Address state/province. |
postalCode required | string [ 1 .. 200 ] characters Postal/zip code. |
country | string or null [ 1 .. 200 ] characters Country identifier. |
shippingLeadTime | integer or null <int32> >= 0 Lead time for shipping contents. |
primaryBilling | boolean Signifies if this is a primary billing address. |
primaryShipping | boolean Signifies if this is a primary billing address. |
string or null <email> Email address | |
phone | string or null Associated phone number |
fax | string or null Associated fax number |
notes | string or null General notes associated to this customer address |
Responses
Request samples
- Payload
{- "name": "string",
- "address1": "string",
- "address2": "string",
- "address3": "string",
- "city": "string",
- "stateProvince": "string",
- "postalCode": "string",
- "country": "string",
- "shippingLeadTime": 0,
- "primaryBilling": true,
- "primaryShipping": true,
- "phone": "string",
- "fax": "string",
- "notes": "string"
}
Response samples
- 200
{- "id": "string"
}
Get a specific customer address
path Parameters
customerId required | string = 24 characters |
customerAddressId required | string = 36 characters |
Responses
Response samples
- 200
{- "name": "string",
- "address1": "string",
- "address2": "string",
- "address3": "string",
- "city": "string",
- "stateProvince": "string",
- "postalCode": "string",
- "country": "string",
- "shippingLeadTime": 0,
- "primaryBilling": true,
- "primaryShipping": true,
- "id": "stringstringstringstringstringstring",
- "phone": "string",
- "fax": "string",
- "notes": "string"
}
Update a specific customer address
path Parameters
customerId required | string = 24 characters |
customerAddressId required | string = 36 characters |
Request Body schema:
name | string or null [ 1 .. 200 ] characters Name of the address (Bob's Shipping, Primary, Reno Warehouse, etc). |
address1 required | string [ 1 .. 200 ] characters Primary address line. |
address2 | string or null [ 1 .. 200 ] characters Second address line. |
address3 | string or null [ 1 .. 200 ] characters Third address line. |
city required | string [ 1 .. 200 ] characters Address city |
stateProvince | string or null [ 1 .. 200 ] characters Address state/province. |
postalCode required | string [ 1 .. 200 ] characters Postal/zip code. |
country | string or null [ 1 .. 200 ] characters Country identifier. |
shippingLeadTime | integer or null <int32> >= 0 Lead time for shipping contents. |
primaryBilling | boolean Signifies if this is a primary billing address. |
primaryShipping | boolean Signifies if this is a primary billing address. |
string or null <email> Email address | |
phone | string or null Associated phone number |
fax | string or null Associated fax number |
notes | string or null General notes associated to this customer address |
Responses
Request samples
- Payload
{- "name": "string",
- "address1": "string",
- "address2": "string",
- "address3": "string",
- "city": "string",
- "stateProvince": "string",
- "postalCode": "string",
- "country": "string",
- "shippingLeadTime": 0,
- "primaryBilling": true,
- "primaryShipping": true,
- "phone": "string",
- "fax": "string",
- "notes": "string"
}
Get a list of addresses for a customer
path Parameters
customerId required | string = 24 characters |
Responses
Response samples
- 200
[- {
- "name": "string",
- "address1": "string",
- "address2": "string",
- "address3": "string",
- "city": "string",
- "stateProvince": "string",
- "postalCode": "string",
- "country": "string",
- "shippingLeadTime": 0,
- "primaryBilling": true,
- "primaryShipping": true,
- "id": "stringstringstringstringstringstring",
- "phone": "string",
- "fax": "string",
- "notes": "string"
}
]
Create a new customer contact
path Parameters
customerId required | string = 24 characters |
Request Body schema:
firstName required | string [ 1 .. 200 ] characters First name |
lastName | string or null [ 1 .. 200 ] characters Last name |
position | string or null [ 1 .. 200 ] characters Position / Job Title |
phone | string or null Phone number |
cellPhone | string or null Cellphone number |
string or null <email> Email address |
Responses
Request samples
- Payload
{- "firstName": "string",
- "lastName": "string",
- "position": "string",
- "phone": "string",
- "cellPhone": "string",
- "email": "[email protected]"
}
Response samples
- 200
{- "id": "string"
}
Get a specific customer contact
path Parameters
customerId required | string = 24 characters The id of the customer to modify contacts for |
contactId required | string = 36 characters The id of the customer contact. |
Responses
Response samples
- 200
{- "id": "stringstringstringstringstringstring",
- "firstName": "string",
- "lastName": "string",
- "position": "string",
- "cellPhone": "string",
- "phone": "string",
- "email": "[email protected]"
}
Update a specific customer contact
path Parameters
customerId required | string = 24 characters The id of the customer to modify contacts for |
contactId required | string = 36 characters The id of the customer contact. |
Request Body schema:
The new data to apply to the given index
firstName required | string [ 1 .. 200 ] characters First name |
lastName | string or null [ 1 .. 200 ] characters Last name |
position | string or null [ 1 .. 200 ] characters Position / Job Title |
phone | string or null Phone number |
cellPhone | string or null Cellphone number |
string or null <email> Email address |
Responses
Request samples
- Payload
{- "firstName": "string",
- "lastName": "string",
- "position": "string",
- "phone": "string",
- "cellPhone": "string",
- "email": "[email protected]"
}
Get a list of contacts for a customer
path Parameters
customerId required | string = 24 characters |
Responses
Response samples
- 200
[- {
- "id": "stringstringstringstringstringstring",
- "firstName": "string",
- "lastName": "string",
- "position": "string",
- "cellPhone": "string",
- "phone": "string",
- "email": "[email protected]"
}
]
Response samples
- 200
{- "id": "stringstringstringstring",
- "name": "string",
- "deleted": true,
- "workCenters": [
- {
- "id": "stringstringstringstring",
- "name": "string",
- "departmentId": "stringstringstringstring",
- "setupRate": 0,
- "runRate": 0,
- "laborRate": 0,
- "overheadRate": 0,
- "machineRate": 0,
- "deleted": true,
- "equipment": [
- {
- "id": "stringstringstringstring",
- "name": "string",
- "description": "string",
- "workCenterId": "stringstringstringstring",
- "manufacturer": "string",
- "modelNumber": "string",
- "serialNumber": "string",
- "canRunUnattended": true,
- "unlimitedCapacity": true,
- "status": "good",
- "notes": "string",
- "deleted": true
}
]
}
]
}
Find departments based on search parameters.
query Parameters
Sort.Field | string non-empty Sort field |
Sort.Dir | string (CommonEnumSortDirectionEnum) Enum: "ascending" "descending" Sort direction |
Skip | integer <int32> >= 0 Number of records to skip. |
Take | integer <int32> [ 0 .. 1000 ] Number of records to return (maximum) |
Request Body schema:
ids | Array of strings or null Filter departments based on matching ids. |
name | string or null [ 1 .. 200 ] characters Filter departments based on their name. |
Responses
Request samples
- Payload
{- "ids": [
- "string"
], - "name": "string"
}
Response samples
- 200
[- {
- "id": "stringstringstringstring",
- "name": "string",
- "deleted": true,
- "workCenters": [
- {
- "id": "stringstringstringstring",
- "name": "string",
- "departmentId": "stringstringstringstring",
- "setupRate": 0,
- "runRate": 0,
- "laborRate": 0,
- "overheadRate": 0,
- "machineRate": 0,
- "deleted": true,
- "equipment": [
- {
- "id": "stringstringstringstring",
- "name": "string",
- "description": "string",
- "workCenterId": "stringstringstringstring",
- "manufacturer": "string",
- "modelNumber": "string",
- "serialNumber": "string",
- "canRunUnattended": true,
- "unlimitedCapacity": true,
- "status": "good",
- "notes": "string",
- "deleted": true
}
]
}
]
}
]
Response samples
- 200
{- "id": "stringstringstringstring",
- "name": "string",
- "description": "string",
- "workCenterId": "stringstringstringstring",
- "manufacturer": "string",
- "modelNumber": "string",
- "serialNumber": "string",
- "canRunUnattended": true,
- "unlimitedCapacity": true,
- "status": "good",
- "notes": "string",
- "deleted": true
}
Find equipment based on search parameters.
query Parameters
Sort.Field | string non-empty Sort field |
Sort.Dir | string (CommonEnumSortDirectionEnum) Enum: "ascending" "descending" Sort direction |
Skip | integer <int32> >= 0 Number of records to skip. |
Take | integer <int32> [ 0 .. 1000 ] Number of records to return (maximum) |
Request Body schema:
ids | Array of strings or null Filter equipment based on matching ids. |
name | string or null [ 1 .. 200 ] characters Filter equipment based on their name. |
Responses
Request samples
- Payload
{- "ids": [
- "string"
], - "name": "string"
}
Response samples
- 200
[- {
- "id": "stringstringstringstring",
- "name": "string",
- "description": "string",
- "workCenterId": "stringstringstringstring",
- "manufacturer": "string",
- "modelNumber": "string",
- "serialNumber": "string",
- "canRunUnattended": true,
- "unlimitedCapacity": true,
- "status": "good",
- "notes": "string",
- "deleted": true
}
]
Find gauge codes based on search parameters.
query Parameters
Sort.Field | string non-empty Sort field |
Sort.Dir | string (CommonEnumSortDirectionEnum) Enum: "ascending" "descending" Sort direction |
Skip | integer <int32> >= 0 Number of records to skip. |
Take | integer <int32> [ 0 .. 1000 ] Number of records to return (maximum) |
Request Body schema:
name | string or null [ 1 .. 200 ] characters Filter gauge codes based on their name. |
ids | Array of strings or null Filter gauge codes based on matching ids. |
Responses
Request samples
- Payload
{- "name": "string",
- "ids": [
- "string"
]
}
Response samples
- 200
[- {
- "id": "stringstringstringstring",
- "name": "string"
}
]
Find grade codes based on search parameters.
query Parameters
Sort.Field | string non-empty Sort field |
Sort.Dir | string (CommonEnumSortDirectionEnum) Enum: "ascending" "descending" Sort direction |
Skip | integer <int32> >= 0 Number of records to skip. |
Take | integer <int32> [ 0 .. 1000 ] Number of records to return (maximum) |
Request Body schema:
name | string or null [ 1 .. 200 ] characters Filter grade codes based on their name. |
ids | Array of strings or null Filter grade codes based on matching ids. |
Responses
Request samples
- Payload
{- "name": "string",
- "ids": [
- "string"
]
}
Response samples
- 200
[- {
- "id": "stringstringstringstring",
- "name": "string"
}
]
Find inventory based on search parameters.
query Parameters
Sort.Field | string non-empty Sort field |
Sort.Dir | string (CommonEnumSortDirectionEnum) Enum: "ascending" "descending" Sort direction |
Skip | integer <int32> >= 0 Number of records to skip. |
Take | integer <int32> [ 0 .. 1000 ] Number of records to return (maximum) |
Request Body schema:
lotIds | Array of strings or null Filter inventory based on lot ids. |
itemIds | Array of strings or null Filter inventory based on item ids. |
locationIds | Array of strings or null Filter inventory based on location ids. |
Responses
Request samples
- Payload
{- "lotIds": [
- "string"
], - "itemIds": [
- "string"
], - "locationIds": [
- "string"
]
}
Response samples
- 200
[- {
- "id": "stringstringstringstring",
- "lotId": "stringstringstringstring",
- "locationId": "stringstringstringstring",
- "quantity": 0,
- "onHandQuantity": 0,
- "itemId": "stringstringstringstring",
- "itemNumber": "string",
- "itemDescription": "string"
}
]
Returns on hand counts by item. Excludes reserved inventory counts by default, but can be included by passing in the ```includeReservec``` query parameter. NOTE: If the response does not contain and item identifier, it means there is no quantity on hand.
query Parameters
includeReserved | boolean Default: false Whether to included reserved inventory into the counts |
Responses
Response samples
- 200
{- "property1": 0,
- "property2": 0
}
Override an inventory's quantity.
Request Body schema:
The parameters for the request
itemId required | string = 24 characters Item identifier. |
quantity required | number <double> The quantity to set the item's inventory level to. |
lotId | string or null The lot identifier to apply this override to |
locationId | string or null The location identifier to apply this override to. |
note | string or null The note to add to the override transaction. |
Responses
Request samples
- Payload
{- "itemId": "stringstringstringstring",
- "quantity": 0,
- "lotId": "string",
- "locationId": "string",
- "note": "string"
}
Pick inventory against a specific item.
Request Body schema:
itemId required | string = 24 characters Item identifier. Please reference /api/items endpoint. |
secondaryType required | string (InventoryPickEventSecondaryType) Enum: "pick" "consume" "scrap" "stockAdjustmentDecrease" "otherDecrease" Secondary event type specifically for picking. |
quantity required | number <double> Quantity of the item to pick. |
locationId | string or null = 24 characters Location id that inventory is picked from. Please reference /api/locations endpoint |
lotId | string or null = 24 characters Lot identifier for this block of inventory. Please reference /api/inventory-lots endpoint |
note | string or null [ 1 .. 2000 ] characters Notes associated to this transaction. |
Responses
Request samples
- Payload
{- "itemId": "stringstringstringstring",
- "secondaryType": "pick",
- "quantity": 0,
- "locationId": "stringstringstringstring",
- "lotId": "stringstringstringstring",
- "note": "string"
}
Receive inventory for a specific item.
Request Body schema:
itemId required | string = 24 characters Item identifier. Please reference /api/items endpoint. |
secondaryType required | string (InventoryReceiveEventSecondaryType) Enum: "receive" "found" "stockAdjustmentIncrease" "otherIncrease" Secondary event type specifically for receiving. |
quantity required | number <double> Quantity of the item to receive. |
locationId | string or null = 24 characters Location id that inventory is received into. Please reference /api/locations endpoint |
lotId | string or null = 24 characters Lot identifier for this block of inventory. Please reference /api/inventory-lots endpoint |
note | string or null [ 1 .. 2000 ] characters Notes associated to this transaction. |
Responses
Request samples
- Payload
{- "itemId": "stringstringstringstring",
- "secondaryType": "receive",
- "quantity": 0,
- "locationId": "stringstringstringstring",
- "lotId": "stringstringstringstring",
- "note": "string"
}
Create a new inventory lot.
Request Body schema:
name | string or null [ 1 .. 200 ] characters The name of the lot. It is not guaranteed to be unique inventory-wide, but only within an item. |
itemId required | string = 24 characters The item id that is associated to this lot. Please reference /api/items endpoint. |
expirationDate | string or null <date-time> The date that this lot is supposed to expire. |
Responses
Request samples
- Payload
{- "name": "string",
- "itemId": "stringstringstringstring",
- "expirationDate": "2019-08-24T14:15:22Z"
}
Response samples
- 200
{- "id": "string"
}
Find inventory lots based on search parameters.
query Parameters
Sort.Field | string non-empty Sort field |
Sort.Dir | string (CommonEnumSortDirectionEnum) Enum: "ascending" "descending" Sort direction |
Skip | integer <int32> >= 0 Number of records to skip. |
Take | integer <int32> [ 0 .. 1000 ] Number of records to return (maximum) |
Request Body schema:
name | string or null [ 1 .. 200 ] characters Filter lots based on their name. |
itemIds | Array of strings or null Item ids to match. Please reference /api/items endpoint. |
system | boolean or null Filter by whether the lot is considered a system-generated lot. |
Responses
Request samples
- Payload
{- "name": "string",
- "itemIds": [
- "string"
], - "system": true
}
Response samples
- 200
[- {
- "id": "stringstringstringstring",
- "name": "string",
- "itemId": "stringstringstringstring",
- "quantity": 0,
- "system": true,
- "custom": true,
- "expirationDate": "2019-08-24T14:15:22Z"
}
]
Finds inventory transactions based on search parameters
query Parameters
Sort.Field | string non-empty Sort field |
Sort.Dir | string (CommonEnumSortDirectionEnum) Enum: "ascending" "descending" Sort direction |
Skip | integer <int32> >= 0 Number of records to skip. |
Take | integer <int32> [ 0 .. 1000 ] Number of records to return (maximum) |
Request Body schema:
itemIds | Array of strings or null Filter inventory transactions based on item identifiers. |
object (DtoCommonDateRangeFilter) Date range used for filters |
Responses
Request samples
- Payload
{- "itemIds": [
- "string"
], - "dateRange": {
- "start": "2019-08-24T14:15:22Z",
- "end": "2019-08-24T14:15:22Z"
}
}
Response samples
- 200
{- "data": [
- {
- "id": "string",
- "date": "2019-08-24T14:15:22Z",
- "type": "pick",
- "secondaryType": "pick",
- "item": {
- "id": "stringstringstringstring",
- "name": "string"
}, - "location": {
- "id": "stringstringstringstring",
- "name": "string"
}, - "lot": {
- "id": "stringstringstringstring",
- "name": "string"
}, - "quantity": 0,
- "valueChange": 0,
- "qtyChange": 0,
- "note": "string"
}
], - "page": 0,
- "pageSize": 0,
- "totalCount": 0,
- "totalPages": 0,
- "hasPreviousPage": true,
- "hasNextPage": true
}
Response samples
- 200
{- "id": "stringstringstringstring",
- "number": 0,
- "issueDate": "2019-08-24T14:15:22Z",
- "status": "new",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "customerId": "stringstringstringstring",
- "paymentTermsId": "stringstringstringstring",
- "companyInfoId": "stringstringstringstring",
- "salesOrderId": "stringstringstringstring",
- "customerPONumber": "string",
- "dueDate": "2019-08-24T14:15:22Z",
- "total": 0,
- "subtotal": 0,
- "notesToCustomer": "string",
- "billingAddress": {
- "name": "string",
- "address1": "string",
- "address2": "string",
- "address3": "string",
- "city": "string",
- "stateProvince": "string",
- "postalCode": "string",
- "country": "string"
}, - "customFields": {
- "property1": null,
- "property2": null
}, - "deleted": true
}
Partially update an invoice
path Parameters
invoiceId required | string = 24 characters |
Request Body schema: application/json-patch+json
op | string |
value | string |
path | string |
Responses
Request samples
- Payload
[- {
- "op": "string",
- "value": "string",
- "path": "string"
}
]
Response samples
- 200
{- "id": "stringstringstringstring",
- "number": 0,
- "issueDate": "2019-08-24T14:15:22Z",
- "status": "new",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "customerId": "stringstringstringstring",
- "paymentTermsId": "stringstringstringstring",
- "companyInfoId": "stringstringstringstring",
- "salesOrderId": "stringstringstringstring",
- "customerPONumber": "string",
- "dueDate": "2019-08-24T14:15:22Z",
- "total": 0,
- "subtotal": 0,
- "notesToCustomer": "string",
- "billingAddress": {
- "name": "string",
- "address1": "string",
- "address2": "string",
- "address3": "string",
- "city": "string",
- "stateProvince": "string",
- "postalCode": "string",
- "country": "string"
}, - "customFields": {
- "property1": null,
- "property2": null
}, - "deleted": true
}
Update an invoice
path Parameters
invoiceId required | string = 24 characters |
Request Body schema:
object or null Arbitrary key-value-pair like data that can be used to later on search for this line item. | |||||||||||||||||
|
Responses
Request samples
- Payload
{- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}
}
Response samples
- 200
{- "id": "stringstringstringstring",
- "number": 0,
- "issueDate": "2019-08-24T14:15:22Z",
- "status": "new",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "customerId": "stringstringstringstring",
- "paymentTermsId": "stringstringstringstring",
- "companyInfoId": "stringstringstringstring",
- "salesOrderId": "stringstringstringstring",
- "customerPONumber": "string",
- "dueDate": "2019-08-24T14:15:22Z",
- "total": 0,
- "subtotal": 0,
- "notesToCustomer": "string",
- "billingAddress": {
- "name": "string",
- "address1": "string",
- "address2": "string",
- "address3": "string",
- "city": "string",
- "stateProvince": "string",
- "postalCode": "string",
- "country": "string"
}, - "customFields": {
- "property1": null,
- "property2": null
}, - "deleted": true
}
Find invoices based on search parameters.
query Parameters
Sort.Field | string non-empty Sort field |
Sort.Dir | string (CommonEnumSortDirectionEnum) Enum: "ascending" "descending" Sort direction |
Skip | integer <int32> >= 0 Number of records to skip. |
Take | integer <int32> [ 0 .. 1000 ] Number of records to return (maximum) |
Request Body schema:
numbers | Array of integers or null <int32> [ 1 .. 500 ] items Filter invoices to only given numbers |
object (CommonExternalReferenceFindDto) Search parameter for identifier record(s) via their external identifiers. | |
status | string (InvoiceStatusEnum) Enum: "new" "needsApproval" "approved" "issued" "paid" Invoice status |
Responses
Request samples
- Payload
{- "numbers": [
- 0
], - "externalReference": {
- "key": "string",
- "type": "string",
- "externalId": "string"
}, - "status": "new"
}
Response samples
- 200
[- {
- "id": "stringstringstringstring",
- "number": 0,
- "issueDate": "2019-08-24T14:15:22Z",
- "status": "new",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "customerId": "stringstringstringstring",
- "paymentTermsId": "stringstringstringstring",
- "companyInfoId": "stringstringstringstring",
- "salesOrderId": "stringstringstringstring",
- "customerPONumber": "string",
- "dueDate": "2019-08-24T14:15:22Z",
- "total": 0,
- "subtotal": 0,
- "notesToCustomer": "string",
- "billingAddress": {
- "name": "string",
- "address1": "string",
- "address2": "string",
- "address3": "string",
- "city": "string",
- "stateProvince": "string",
- "postalCode": "string",
- "country": "string"
}, - "customFields": {
- "property1": null,
- "property2": null
}, - "deleted": true
}
]
Update an invoice status
path Parameters
invoiceId required | string = 24 characters |
Request Body schema:
status required | string (InvoiceStatusEnum) Enum: "new" "needsApproval" "approved" "issued" "paid" Invoice status |
paidDate | string or null <date-time> The date that the invoice was paid. |
Responses
Request samples
- Payload
{- "status": "new",
- "paidDate": "2019-08-24T14:15:22Z"
}
Get a specific deposit adjustment line item for an invoice
path Parameters
invoiceId required | string = 24 characters |
lineItemId required | string = 36 characters |
Responses
Response samples
- 200
{- "id": "stringstringstringstringstringstring",
- "name": "string",
- "description": "string",
- "price": 0,
- "accountingCodeId": "stringstringstringstring",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "salesOrderLineItemId": "stringstringstringstringstringstring"
}
Get a list of deposit adjustment lines items for an invoice
path Parameters
invoiceId required | string = 24 characters |
Responses
Response samples
- 200
[- {
- "id": "stringstringstringstringstringstring",
- "name": "string",
- "description": "string",
- "price": 0,
- "accountingCodeId": "stringstringstringstring",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "salesOrderLineItemId": "stringstringstringstringstringstring"
}
]
Get a specific deposit line item for an invoice
path Parameters
invoiceId required | string = 24 characters |
lineItemId required | string = 36 characters |
Responses
Response samples
- 200
{- "id": "stringstringstringstringstringstring",
- "name": "string",
- "description": "string",
- "amount": 0,
- "accountingCodeId": "stringstringstringstring",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "salesOrderLineItemId": "stringstringstringstringstringstring"
}
Get a list of deposit lines items for an invoice
path Parameters
invoiceId required | string = 24 characters |
Responses
Response samples
- 200
[- {
- "id": "stringstringstringstringstringstring",
- "name": "string",
- "description": "string",
- "amount": 0,
- "accountingCodeId": "stringstringstringstring",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "salesOrderLineItemId": "stringstringstringstringstringstring"
}
]
Get the discount line item for an invoice
path Parameters
invoiceId required | string = 24 characters |
Responses
Response samples
- 200
{- "id": "stringstringstringstringstringstring",
- "name": "string",
- "description": "string",
- "isPercentage": true,
- "amount": 0,
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}
}
Get a specific fee line item for an invoice
path Parameters
invoiceId required | string = 24 characters |
lineItemId required | string = 36 characters |
Responses
Response samples
- 200
{- "id": "stringstringstringstringstringstring",
- "name": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "unitOfMeasure": "notApplicable",
- "accountingCodeId": "stringstringstringstring",
- "isTaxable": true,
- "overrideTaxRate": true,
- "taxCodeId": "stringstringstringstring",
- "taxRate": 0,
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "salesOrderLineItemId": "stringstringstringstringstringstring"
}
Partially update a specific fee line item for a purchase order
path Parameters
invoiceId required | string = 24 characters |
lineItemId required | string = 36 characters |
Request Body schema: application/json-patch+json
op | string |
value | string |
path | string |
Responses
Request samples
- Payload
[- {
- "op": "string",
- "value": "string",
- "path": "string"
}
]
Response samples
- 200
{- "id": "stringstringstringstringstringstring",
- "name": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "unitOfMeasure": "notApplicable",
- "accountingCodeId": "stringstringstringstring",
- "isTaxable": true,
- "overrideTaxRate": true,
- "taxCodeId": "stringstringstringstring",
- "taxRate": 0,
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "salesOrderLineItemId": "stringstringstringstringstringstring"
}
Update a specific fee line item for an invoice
path Parameters
invoiceId required | string = 24 characters |
lineItemId required | string = 36 characters |
Request Body schema:
object or null Arbitrary key-value-pair like data that can be used to later on search for this line item. | |||||||||||||||||
|
Responses
Request samples
- Payload
{- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}
}
Response samples
- 200
{- "id": "stringstringstringstringstringstring",
- "name": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "unitOfMeasure": "notApplicable",
- "accountingCodeId": "stringstringstringstring",
- "isTaxable": true,
- "overrideTaxRate": true,
- "taxCodeId": "stringstringstringstring",
- "taxRate": 0,
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "salesOrderLineItemId": "stringstringstringstringstringstring"
}
Get a list of fee lines items for an invoice
path Parameters
invoiceId required | string = 24 characters |
Responses
Response samples
- 200
[- {
- "id": "stringstringstringstringstringstring",
- "name": "string",
- "description": "string",
- "quantity": 0,
- "price": 0,
- "unitOfMeasure": "notApplicable",
- "accountingCodeId": "stringstringstringstring",
- "isTaxable": true,
- "overrideTaxRate": true,
- "taxCodeId": "stringstringstringstring",
- "taxRate": 0,
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "salesOrderLineItemId": "stringstringstringstringstringstring"
}
]
Get a specific line item for an invoice of generic type
path Parameters
invoiceId required | string = 24 characters |
lineItemId required | string = 36 characters |
Responses
Response samples
- 200
{- "id": "stringstringstringstringstringstring",
- "type": "part",
- "quantity": 0,
- "price": 0,
- "discountedPrice": 0,
- "subtotal": 0,
- "discountedSubtotal": 0,
- "name": "string",
- "description": "string",
- "accountingCodeId": "stringstringstringstring",
- "taxCodeId": "stringstringstringstring",
- "salesOrderLineItemId": "stringstringstringstringstringstring",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "isTaxable": true
}
Get a list of lines items for an invoice, regardless of type
path Parameters
invoiceId required | string = 24 characters |
Responses
Response samples
- 200
[- {
- "id": "stringstringstringstringstringstring",
- "type": "part",
- "quantity": 0,
- "price": 0,
- "discountedPrice": 0,
- "subtotal": 0,
- "discountedSubtotal": 0,
- "name": "string",
- "description": "string",
- "accountingCodeId": "stringstringstringstring",
- "taxCodeId": "stringstringstringstring",
- "salesOrderLineItemId": "stringstringstringstringstringstring",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "isTaxable": true
}
]
Get a specific part line item for an invoice
path Parameters
invoiceId required | string = 24 characters |
lineItemId required | string = 36 characters |
Responses
Response samples
- 200
{- "id": "stringstringstringstringstringstring",
- "name": "string",
- "quantity": 0,
- "price": 0,
- "discountedPrice": 0,
- "overrideTaxRate": true,
- "isTaxable": true,
- "taxCodeId": "stringstringstringstring",
- "taxRate": 0,
- "itemId": "stringstringstringstring",
- "description": "string",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "accountingCodeId": "stringstringstringstring",
- "salesOrderLineItemId": "stringstringstringstringstringstring",
- "subTotal": 0,
- "preDiscountSubTotal": 0,
- "isPercentageDiscount": true,
- "discountAmount": 0
}
Partially update a specific part line item for an invoice
path Parameters
invoiceId required | string = 24 characters |
lineItemId required | string = 36 characters |
Request Body schema: application/json-patch+json
op | string |
value | string |
path | string |
Responses
Request samples
- Payload
[- {
- "op": "string",
- "value": "string",
- "path": "string"
}
]
Response samples
- 200
{- "id": "stringstringstringstringstringstring",
- "name": "string",
- "quantity": 0,
- "price": 0,
- "discountedPrice": 0,
- "overrideTaxRate": true,
- "isTaxable": true,
- "taxCodeId": "stringstringstringstring",
- "taxRate": 0,
- "itemId": "stringstringstringstring",
- "description": "string",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "accountingCodeId": "stringstringstringstring",
- "salesOrderLineItemId": "stringstringstringstringstringstring",
- "subTotal": 0,
- "preDiscountSubTotal": 0,
- "isPercentageDiscount": true,
- "discountAmount": 0
}
Update a specific part line item for an invoice
path Parameters
invoiceId required | string = 24 characters |
lineItemId required | string = 36 characters |
Request Body schema:
object or null Arbitrary key-value-pair like data that can be used to later on search for this line item. | |||||||||||||||||
|
Responses
Request samples
- Payload
{- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}
}
Response samples
- 200
{- "id": "stringstringstringstringstringstring",
- "name": "string",
- "quantity": 0,
- "price": 0,
- "discountedPrice": 0,
- "overrideTaxRate": true,
- "isTaxable": true,
- "taxCodeId": "stringstringstringstring",
- "taxRate": 0,
- "itemId": "stringstringstringstring",
- "description": "string",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "accountingCodeId": "stringstringstringstring",
- "salesOrderLineItemId": "stringstringstringstringstringstring",
- "subTotal": 0,
- "preDiscountSubTotal": 0,
- "isPercentageDiscount": true,
- "discountAmount": 0
}
Get a list of part lines items for an invoice
path Parameters
invoiceId required | string = 24 characters |
Responses
Response samples
- 200
[- {
- "id": "stringstringstringstringstringstring",
- "name": "string",
- "quantity": 0,
- "price": 0,
- "discountedPrice": 0,
- "overrideTaxRate": true,
- "isTaxable": true,
- "taxCodeId": "stringstringstringstring",
- "taxRate": 0,
- "itemId": "stringstringstringstring",
- "description": "string",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "accountingCodeId": "stringstringstringstring",
- "salesOrderLineItemId": "stringstringstringstringstringstring",
- "subTotal": 0,
- "preDiscountSubTotal": 0,
- "isPercentageDiscount": true,
- "discountAmount": 0
}
]
Get a specific refund line item for an invoice
path Parameters
invoiceId required | string = 24 characters |
lineItemId required | string = 36 characters |
Responses
Response samples
- 200
{- "id": "stringstringstringstringstringstring",
- "quantity": 0,
- "price": 0,
- "itemId": "stringstringstringstring",
- "name": "string",
- "description": "string",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "salesOrderLineItemId": "stringstringstringstringstringstring",
- "accountingCodeId": "stringstringstringstring"
}
Partially update a specific refund line item for a purchase order
path Parameters
invoiceId required | string = 24 characters |
lineItemId required | string = 36 characters |
Request Body schema: application/json-patch+json
op | string |
value | string |
path | string |
Responses
Request samples
- Payload
[- {
- "op": "string",
- "value": "string",
- "path": "string"
}
]
Response samples
- 200
{- "id": "stringstringstringstringstringstring",
- "quantity": 0,
- "price": 0,
- "itemId": "stringstringstringstring",
- "name": "string",
- "description": "string",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "salesOrderLineItemId": "stringstringstringstringstringstring",
- "accountingCodeId": "stringstringstringstring"
}
Update a specific refund line item for an invoice
path Parameters
invoiceId required | string = 24 characters |
lineItemId required | string = 36 characters |
Request Body schema:
object or null Arbitrary key-value-pair like data that can be used to later on search for this line item. | |||||||||||||||||
|
Responses
Request samples
- Payload
{- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}
}
Response samples
- 200
{- "id": "stringstringstringstringstringstring",
- "quantity": 0,
- "price": 0,
- "itemId": "stringstringstringstring",
- "name": "string",
- "description": "string",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "salesOrderLineItemId": "stringstringstringstringstringstring",
- "accountingCodeId": "stringstringstringstring"
}
Get a list of refund lines items for an invoice
path Parameters
invoiceId required | string = 24 characters |
Responses
Response samples
- 200
[- {
- "id": "stringstringstringstringstringstring",
- "quantity": 0,
- "price": 0,
- "itemId": "stringstringstringstring",
- "name": "string",
- "description": "string",
- "externalReferences": {
- "property1": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}, - "property2": {
- "type": "string",
- "externalId": "string",
- "displayId": "string",
- "status": "string",
- "url": "string",
- "modifiedUtc": "2019-08-24T14:15:22Z"
}
}, - "salesOrderLineItemId": "stringstringstringstringstringstring",
- "accountingCodeId": "stringstringstringstring"
}
]