Update a Bill of Materials
/BillOfMaterials/{billOfMaterialsGuid}Inspect fields and contract →
An Unleashed MCP connector for stock, products, sales orders and purchasing. Explore the coverage and join the access waitlist.
Inventory and orders
MCP XYZ is building an independent Unleashed MCP connector so an AI assistant can work with authorised inventory and order records through the Model Context Protocol. The connector covers documented Unleashed API operations; new access is by invitation from the waitlist, and live business workflows still need validation.
Use the catalogue to check the operations and fields your work needs. If an existing connector is missing a useful action, tell us about it when joining the waitlist. Your software’s permissions and API limits still apply.
Explore documented product, stock-on-hand and warehouse operations for questions about inventory across your business.
Inspect documented operations →Inspect sales-order and customer operations, including the products, quantities and prices retained in their documented fields.
Inspect documented operations →Review the purchase-order, receipt and supplier coverage before planning an authorised purchasing workflow.
Inspect documented operations →“Show stock on hand by warehouse for this product.”
New access starts with the Unleashed waitlist. Tell us which assistant you use and the work you want to do. We’ll contact you about relevant access updates; joining does not create an account or guarantee an invitation date.
Once invited, sign in to MCP XYZ, choose your workspace and add the API ID and key for your authorised Unleashed account. Run the connection check, then add its MCP URL to your assistant. Saved credentials alone do not verify a connection.
Start with read-only access while you explore. Jiffi can handle setup with you. Live business workflows still need validation against an authorised account.
In Claude Desktop or web, open Settings → Connectors → Add custom connector, enter your connection’s MCP URL, then connect and choose access in MCP XYZ.
Read the AI client guide → How access and permissions work →
Documented coverage
145 documented operation variants. Open a contract to inspect its parameters, fields, sources and unresolved behaviour. No provider request is made here.
145 operations match. Showing 21–40.
/BillOfMaterials/{billOfMaterialsGuid}Inspect fields and contract →/CreditNotesInspect fields and contract →/CreditNotes/{creditNoteGuid}Inspect fields and contract →/CreditNotes/FreeCreditInspect fields and contract →/CreditNotes/{creditNoteGuid}Inspect fields and contract →/CreditNotes/{creditNoteGuid}Inspect fields and contract →/CreditNotes/{creditNoteGuid}/CompleteInspect fields and contract →/CreditNotes/{creditNoteGuid}/LinesInspect fields and contract →/CreditNotes/{creditNoteGuid}/Lines/{creditNoteLineGuid}Inspect fields and contract →/CreditNotes/{creditNoteGuid}/Lines/{creditNoteLineGuid}Inspect fields and contract →/CustomersInspect fields and contract →/Customers/{customerGuid}Inspect fields and contract →/Customers/{customerGuid}/ContactsInspect fields and contract →/CustomersInspect fields and contract →/Customers/{customerGuid}Inspect fields and contract →/Customers/{customerGuid}/ContactsInspect fields and contract →/Customers/{customerGuid}/Contacts/{contactGuid}Inspect fields and contract →/Customers/{customerGuid}/Contacts/{contactGuid}Inspect fields and contract →/ProductsInspect fields and contract →/Products/{productGuid}Inspect fields and contract →Documented contract, live behaviour unverified
unleashed_delete_credit_notesRead the provider documentation ↗
| Parameter | Required | Provider description |
|---|---|---|
creditNoteGuid | Yes | Provider identifier from the corresponding resource; preserve the documented identifier type. |
These source tables cover the resource’s documented methods. Read each table’s heading for its request or response context.
GET Credit Notes
| Property | Type | Length |
|---|---|---|
| BCSubTotal | Decimal | |
| BCTotal | Decimal | |
| Comments | String | 2048 |
| CreatedBy | String | 50 |
| CreatedOn | DateTime | |
| CreditDate | Nullable DateTime | |
| CreditLines | CreditLine collection | |
| CreditNumber | String | 20 |
| CreditType | String | 20 |
| Customer | Customer | |
| Currency | Currency | |
| Guid | Guid | |
| InvoiceNumber | String | 20 |
| LastModifiedBy | String | 50 |
| LastModifiedOn | Nullable DateTime | |
| RequiredDeliveryDate | Nullable DateTime | |
| Reference | String | 500 |
| SalesInvoiceDate | Nullable DateTime | |
| SalesOrder | SalesOrder | |
| Status | String | 20 |
| SubTotal | Decimal | |
| Tax | Tax | |
| TaxRate | Nullable Decimal | |
| TaxTotal | Decimal | |
| Total | Decimal | |
| Warehouse | Warehouse |
GET Credit Notes
| Property | Type | Length |
|---|---|---|
| CurrencyCode | String | 3 |
| DefaultBuyRate | Nullable Decimal | |
| DefaultSellRate | Nullable Decimal | |
| Description | String | 200 |
| Guid | Guid | |
| LastModifiedOn | DateTime |
GET Credit Notes
| Property | Type | Length |
|---|---|---|
| CustomerCode | String | 500 |
| CustomerName | String | 500 |
| Guid | Guid | |
| LastModifiedOn | DateTime |
GET Credit Notes
| Property | Type | Length |
|---|---|---|
| Guid | Guid | |
| OrderNumber | String | 20 |
GET Credit Notes
| Property | Type | Length |
|---|---|---|
| CanApplyToExpenses | Boolean | |
| CanApplyToRevenue | Boolean | |
| Description | String | 50 |
| Guid | Guid | |
| LastModifiedOn | DateTime | |
| Obsolete | Boolean | |
| TaxCode | String | 25 |
| TaxRate | Decimal |
GET Credit Notes
| Property | Type | Length |
|---|---|---|
| AddressLine1 | String | 500 |
| AddressLine2 | String | 50 |
| City | String | 500 |
| Comments | String | 2048 |
| ContactName | String | 50 |
| Country | String | 500 |
| DDINumber | String | 25 |
| ExchangeRate | Nullable Decimal | |
| FaxNumber | String | 25 |
| Guid | Guid | |
| IsDefault | Boolean | |
| LastModifiedOn | DateTime | |
| MobileNumber | String | 25 |
| Obsolete | Boolean | |
| PhoneNumber | String | 25 |
| PostCode | String | 500 |
| Region | String | 500 |
| StreetNo | String | 500 |
| WarehouseCode | String | 15 |
| WarehouseName | String | 100 |
GET Credit Notes
| Property | Type | Length |
|---|---|---|
| AverageLandedPriceAtTimeOfSale | Nullable Decimal | |
| BatchNumbers | BatchNumber Collection | |
| BCLineTax | Nullable Decimal | |
| BCLineTotal | Decimal | |
| Comments | String | 1024 |
| CostOfGoodsAccount | String | 500 |
| CreditPrice | Decimal | |
| CreditQuantity | Decimal | |
| Disassemble | Boolean | |
| LineNumber | Integer | |
| LastModifiedOn | DateTime | |
| LineTax | Nullable Decimal | |
| LineTaxCode | String | 50 |
| LineTotal | Decimal | |
| LineType | String | |
| OrderQuantity | Decimal | |
| PendingBatchNumbers | PendingBatchNumber Collection | |
| PendingSerialNumbers | PendingSerialNumber Collection | |
| Product | Product | |
| Reason | String | 100 |
| ReturnToStock | Boolean | |
| SerialNumbers | SerialNumber Collection | |
| TaxRate | Decimal | |
| XeroSalesAccount | String | 50 |
| XeroTaxCode | String | 50 |
GET Credit Notes
| Property | Type | Length |
|---|---|---|
| ExpiryDate | Nullable DateTime | |
| Guid | Guid | |
| LastModifiedOn | DateTime | |
| Number | String | 50 |
| Quantity | Decimal |
GET Credit Notes
| Property | Type | Length |
|---|---|---|
| CreatedOn | DateTime | |
| ExpiryDate | Nullable DateTime | |
| Number | String | 50 |
| Quantity | Decimal |
GET Credit Notes
| Property | Type | Length |
|---|---|---|
| CreatedOn | DateTime | |
| Identifier | String | 50 |
GET Credit Notes
| Property | Type | Length |
|---|---|---|
| Guid | Guid | |
| ProductCode | String | 100 |
| ProductDescription | String | 500 |
GET Credit Notes
| Property | Type | Length |
|---|---|---|
| Guid | Guid | |
| Identifier | String | 50 |
| LastModifiedOn | DateTime |
POST/PUT Credit Notes
| Property | Type | Length | POST | PUT |
|---|---|---|---|---|
| Comments | String | 1024 | ||
| CreditDate | DateTime | Required | Required | |
| CreditLines | CreditLine collection | |||
| Customer | Customer | Required | N/A | |
| ExchangeRate | Decimal | Required | Required | |
| Reference | String | 500 | ||
| Warehouse | Warehouse | Required | Required |
POST/PUT Credit Notes
| Property | Type | Length | POST | PUT |
|---|---|---|---|---|
| CustomerCode | String | 500 | Optional | N/A |
| Guid | Guid | 15 | Optional | N/A |
POST/PUT Credit Notes
| Property | Type | Length | POST | PUT |
|---|---|---|---|---|
| Guid | Guid | Optional | N/A | |
| WarehouseCode | String | 15 | Optional | N/A |
POST/PUT Credit Notes
| Property | Type | Length | POST | PUT |
|---|---|---|---|---|
| BatchNumbers | BatchNumber Collection | |||
| Comments | String | 1024 | ||
| CreditPrice | Decimal | Required | Required | |
| CreditQuantity | Decimal | Required | Required | |
| Guid | Guid | N/A | Required | |
| Product | Product | Required | N/A | |
| Reason | String | Required | Required | |
| Return | Boolean | Required | Required | |
| SerialNumbers | SerialNumber Collection |
POST/PUT Credit Notes
| Property | Type | Length | POST | PUT |
|---|---|---|---|---|
| BatchNumber (XML) / Number (JSON) | String | 50 | Required | Required |
| ExpiryDate | Nullable DateTime | |||
| Quantity | Decimal | Required | Required |
POST/PUT Credit Notes
| Property | Type | Length | POST | PUT |
|---|---|---|---|---|
| Guid | Guid | Optional | N/A | |
| ProductCode | String | 100 | Optional | N/A |
POST/PUT Credit Notes
| Property | Type | Length | POST | PUT |
|---|---|---|---|---|
| SerialNumber (XML) / Identifier (JSON) | String | 50 | Required | Required |
Examples for Request PUT /CreditNotes/{CreditNoteGuid}
| Property | Type | Length | POST | PUT |
|---|---|---|---|---|
| Comments | String | 1024 | ||
| BatchNumbers | BatchNumber Collection | |||
| CreditPrice | Decimal | Required | Required | |
| CreditQuantity | Decimal | Required | Required | |
| Guid | Guid | N/A | Required | |
| Product | Product | Required | N/A | |
| Reason | String | Required | Required | |
| Return | Boolean | Required | Required | |
| SerialNumbers | SerialNumber Collection |
Examples for Request PUT /CreditNotes/{CreditNoteGuid}
| Property | Type | Length | POST | PUT |
|---|---|---|---|---|
| BatchNumber (XML) / Number (JSON) | String | 50 | Required | Required |
| ExpiryDate | Nullable DateTime | |||
| Quantity | Decimal | Required | Required |
Examples for Request PUT /CreditNotes/{CreditNoteGuid}
| Property | Type | Length | POST | PUT |
|---|---|---|---|---|
| Guid | Guid | Optional | N/A | |
| ProductCode | String | 100 | Optional | N/A |
Examples for Request PUT /CreditNotes/{CreditNoteGuid}
| Property | Type | Length | POST | PUT |
|---|---|---|---|---|
| SerialNumber (XML) / Identifier (JSON) | String | 50 | Required | Required |
GET Credit Notes
| Filter | Description |
|---|---|
| creditNumber | Returns a single credit note with the specified credit number. If specified, it overrides all other filters. |
| creditStatus | Returns credits for the specified status. |
| endDate | Returns credits created before a specified date. |
| modifiedSince | Returns credits created or edited after a specified date. |
| pageSize | Specifies the page size for pagination. Default page size is 200 credits. Note: Requesting large numbers of contacts can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests. |
| startDate | Returns credits created after a specified date. |
The exact retained JSON includes schemas, nested fields, notes, source evidence and unresolved questions. It is a documented contract, not a live response.
{
"id": "delete_credit_notes",
"name": "unleashed_delete_credit_notes",
"resourceId": "CreditNotes",
"description": "Delete an existing free entry Credit Note with the specified Guid",
"method": "DELETE",
"path": "/CreditNotes/{creditNoteGuid}",
"documentationUrl": "https://apidocs.unleashedsoftware.com/CreditNotes",
"readOnly": false,
"destructive": true,
"idempotent": false,
"pathParameters": [
{
"name": "creditNoteGuid",
"required": true,
"schema": {
"type": "string",
"minLength": 1
},
"description": "Provider identifier from the corresponding resource; preserve the documented identifier type."
}
],
"queryParameters": [],
"requestBodySchema": null,
"responseSchema": null,
"pagination": null,
"notes": [
"Do not automatically replay after an ambiguous transport failure. The documentation does not establish an idempotency-key contract for this operation."
],
"provenance": [
{
"sourceUrl": "https://apidocs.unleashedsoftware.com/CreditNotes",
"sourceSha256": "f5b734efab1552ebd1f250311651849930883b84ea672929361229a20d25d99d",
"section": "The full range of URIs and HTTP Verbs supported are",
"evidence": "DELETE /CreditNotes/{creditNoteGuid}",
"operationDescriptions": [
"Delete an existing free entry Credit Note with the specified Guid"
]
}
],
"confidence": "documented-route",
"unresolved": [
"No authenticated sandbox or production request has verified this operation."
],
"requestFieldTable": null,
"responseFieldTable": null
}{
"id": "CreditNotes",
"name": "Credit Notes",
"group": "Editable resources",
"documentationUrl": "https://apidocs.unleashedsoftware.com/CreditNotes",
"snapshot": "snapshots/CreditNotes.html",
"sourceSha256": "f5b734efab1552ebd1f250311651849930883b84ea672929361229a20d25d99d",
"fetchedAt": "2026-10-23T14:00:31.228629+00:00",
"operationIds": [
"list_credit_notes",
"get_credit_notes",
"create_credit_notes_free_credit",
"update_credit_notes",
"delete_credit_notes",
"complete_credit_notes",
"create_credit_notes_lines",
"update_credit_notes_lines",
"delete_credit_notes_lines"
],
"fieldTables": [
{
"heading": "GET Credit Notes",
"anchor": "get-credit-notes",
"summary": "Available Fields for GET Credit Notes",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"BCSubTotal",
"Decimal",
""
],
[
"BCTotal",
"Decimal",
""
],
[
"Comments",
"String",
"2048"
],
[
"CreatedBy",
"String",
"50"
],
[
"CreatedOn",
"DateTime",
""
],
[
"CreditDate",
"Nullable DateTime",
""
],
[
"CreditLines",
"CreditLine collection",
""
],
[
"CreditNumber",
"String",
"20"
],
[
"CreditType",
"String",
"20"
],
[
"Customer",
"Customer",
""
],
[
"Currency",
"Currency",
""
],
[
"Guid",
"Guid",
""
],
[
"InvoiceNumber",
"String",
"20"
],
[
"LastModifiedBy",
"String",
"50"
],
[
"LastModifiedOn",
"Nullable DateTime",
""
],
[
"RequiredDeliveryDate",
"Nullable DateTime",
""
],
[
"Reference",
"String",
"500"
],
[
"SalesInvoiceDate",
"Nullable DateTime",
""
],
[
"SalesOrder",
"SalesOrder",
""
],
[
"Status",
"String",
"20"
],
[
"SubTotal",
"Decimal",
""
],
[
"Tax",
"Tax",
""
],
[
"TaxRate",
"Nullable Decimal",
""
],
[
"TaxTotal",
"Decimal",
""
],
[
"Total",
"Decimal",
""
],
[
"Warehouse",
"Warehouse",
""
]
]
},
{
"heading": "GET Credit Notes",
"anchor": "get-credit-notes",
"summary": "Available Fields for Currency",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"CurrencyCode",
"String",
"3"
],
[
"DefaultBuyRate",
"Nullable Decimal",
""
],
[
"DefaultSellRate",
"Nullable Decimal",
""
],
[
"Description",
"String",
"200"
],
[
"Guid",
"Guid",
""
],
[
"LastModifiedOn",
"DateTime",
""
]
]
},
{
"heading": "GET Credit Notes",
"anchor": "get-credit-notes",
"summary": "Available Fields for Customer",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"CustomerCode",
"String",
"500"
],
[
"CustomerName",
"String",
"500"
],
[
"Guid",
"Guid",
""
],
[
"LastModifiedOn",
"DateTime",
""
]
]
},
{
"heading": "GET Credit Notes",
"anchor": "get-credit-notes",
"summary": "Available Fields for Sales Orders",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"Guid",
"Guid",
""
],
[
"OrderNumber",
"String",
"20"
]
]
},
{
"heading": "GET Credit Notes",
"anchor": "get-credit-notes",
"summary": "Available Fields for Tax",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"CanApplyToExpenses",
"Boolean",
""
],
[
"CanApplyToRevenue",
"Boolean",
""
],
[
"Description",
"String",
"50"
],
[
"Guid",
"Guid",
""
],
[
"LastModifiedOn",
"DateTime",
""
],
[
"Obsolete",
"Boolean",
""
],
[
"TaxCode",
"String",
"25"
],
[
"TaxRate",
"Decimal",
""
]
]
},
{
"heading": "GET Credit Notes",
"anchor": "get-credit-notes",
"summary": "Available Fields for Warehouse",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"AddressLine1",
"String",
"500"
],
[
"AddressLine2",
"String",
"50"
],
[
"City",
"String",
"500"
],
[
"Comments",
"String",
"2048"
],
[
"ContactName",
"String",
"50"
],
[
"Country",
"String",
"500"
],
[
"DDINumber",
"String",
"25"
],
[
"ExchangeRate",
"Nullable Decimal",
""
],
[
"FaxNumber",
"String",
"25"
],
[
"Guid",
"Guid",
""
],
[
"IsDefault",
"Boolean",
""
],
[
"LastModifiedOn",
"DateTime",
""
],
[
"MobileNumber",
"String",
"25"
],
[
"Obsolete",
"Boolean",
""
],
[
"PhoneNumber",
"String",
"25"
],
[
"PostCode",
"String",
"500"
],
[
"Region",
"String",
"500"
],
[
"StreetNo",
"String",
"500"
],
[
"WarehouseCode",
"String",
"15"
],
[
"WarehouseName",
"String",
"100"
]
]
},
{
"heading": "GET Credit Notes",
"anchor": "get-credit-notes",
"summary": "Available Fields for Credit Lines",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"AverageLandedPriceAtTimeOfSale",
"Nullable Decimal",
""
],
[
"BatchNumbers",
"BatchNumber Collection",
""
],
[
"BCLineTax",
"Nullable Decimal",
""
],
[
"BCLineTotal",
"Decimal",
""
],
[
"Comments",
"String",
"1024"
],
[
"CostOfGoodsAccount",
"String",
"500"
],
[
"CreditPrice",
"Decimal",
""
],
[
"CreditQuantity",
"Decimal",
""
],
[
"Disassemble",
"Boolean",
""
],
[
"LineNumber",
"Integer",
""
],
[
"LastModifiedOn",
"DateTime",
""
],
[
"LineTax",
"Nullable Decimal",
""
],
[
"LineTaxCode",
"String",
"50"
],
[
"LineTotal",
"Decimal",
""
],
[
"LineType",
"String",
""
],
[
"OrderQuantity",
"Decimal",
""
],
[
"PendingBatchNumbers",
"PendingBatchNumber Collection",
""
],
[
"PendingSerialNumbers",
"PendingSerialNumber Collection",
""
],
[
"Product",
"Product",
""
],
[
"Reason",
"String",
"100"
],
[
"ReturnToStock",
"Boolean",
""
],
[
"SerialNumbers",
"SerialNumber Collection",
""
],
[
"TaxRate",
"Decimal",
""
],
[
"XeroSalesAccount",
"String",
"50"
],
[
"XeroTaxCode",
"String",
"50"
]
]
},
{
"heading": "GET Credit Notes",
"anchor": "get-credit-notes",
"summary": "Available Fields for Batch Number",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"ExpiryDate",
"Nullable DateTime",
""
],
[
"Guid",
"Guid",
""
],
[
"LastModifiedOn",
"DateTime",
""
],
[
"Number",
"String",
"50"
],
[
"Quantity",
"Decimal",
""
]
]
},
{
"heading": "GET Credit Notes",
"anchor": "get-credit-notes",
"summary": "Available Fields for Pending Batch Number",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"CreatedOn",
"DateTime",
""
],
[
"ExpiryDate",
"Nullable DateTime",
""
],
[
"Number",
"String",
"50"
],
[
"Quantity",
"Decimal",
""
]
]
},
{
"heading": "GET Credit Notes",
"anchor": "get-credit-notes",
"summary": "Available Fields for Pending Serial Numbers",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"CreatedOn",
"DateTime",
""
],
[
"Identifier",
"String",
"50"
]
]
},
{
"heading": "GET Credit Notes",
"anchor": "get-credit-notes",
"summary": "Available Fields for Product",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"Guid",
"Guid",
""
],
[
"ProductCode",
"String",
"100"
],
[
"ProductDescription",
"String",
"500"
]
]
},
{
"heading": "GET Credit Notes",
"anchor": "get-credit-notes",
"summary": "Available Fields for Serial Numbers",
"rows": [
[
"Property",
"Type",
"Length"
],
[
"Guid",
"Guid",
""
],
[
"Identifier",
"String",
"50"
],
[
"LastModifiedOn",
"DateTime",
""
]
]
},
{
"heading": "POST/PUT Credit Notes",
"anchor": "postput-credit-notes",
"summary": "Available Fields for POST/PUT Credit Notes",
"rows": [
[
"Property",
"Type",
"Length",
"POST",
"PUT"
],
[
"Comments",
"String",
"1024",
"",
""
],
[
"CreditDate",
"DateTime",
"",
"Required",
"Required"
],
[
"CreditLines",
"CreditLine collection",
"",
"",
""
],
[
"Customer",
"Customer",
"",
"Required",
"N/A"
],
[
"ExchangeRate",
"Decimal",
"",
"Required",
"Required"
],
[
"Reference",
"String",
"500",
"",
""
],
[
"Warehouse",
"Warehouse",
"",
"Required",
"Required"
]
]
},
{
"heading": "POST/PUT Credit Notes",
"anchor": "postput-credit-notes",
"summary": "Available Fields for Customer",
"rows": [
[
"Property",
"Type",
"Length",
"POST",
"PUT"
],
[
"CustomerCode",
"String",
"500",
"Optional",
"N/A"
],
[
"Guid",
"Guid",
"15",
"Optional",
"N/A"
]
]
},
{
"heading": "POST/PUT Credit Notes",
"anchor": "postput-credit-notes",
"summary": "Available Fields for Warehouse",
"rows": [
[
"Property",
"Type",
"Length",
"POST",
"PUT"
],
[
"Guid",
"Guid",
"",
"Optional",
"N/A"
],
[
"WarehouseCode",
"String",
"15",
"Optional",
"N/A"
]
]
},
{
"heading": "POST/PUT Credit Notes",
"anchor": "postput-credit-notes",
"summary": "Available Fields for Credit Lines",
"rows": [
[
"Property",
"Type",
"Length",
"POST",
"PUT"
],
[
"BatchNumbers",
"BatchNumber Collection",
"",
"",
""
],
[
"Comments",
"String",
"1024",
"",
""
],
[
"CreditPrice",
"Decimal",
"",
"Required",
"Required"
],
[
"CreditQuantity",
"Decimal",
"",
"Required",
"Required"
],
[
"Guid",
"Guid",
"",
"N/A",
"Required"
],
[
"Product",
"Product",
"",
"Required",
"N/A"
],
[
"Reason",
"String",
"",
"Required",
"Required"
],
[
"Return",
"Boolean",
"",
"Required",
"Required"
],
[
"SerialNumbers",
"SerialNumber Collection",
"",
"",
""
]
]
},
{
"heading": "POST/PUT Credit Notes",
"anchor": "postput-credit-notes",
"summary": "Available Fields for Batch Number",
"rows": [
[
"Property",
"Type",
"Length",
"POST",
"PUT"
],
[
"BatchNumber (XML) / Number (JSON)",
"String",
"50",
"Required",
"Required"
],
[
"ExpiryDate",
"Nullable DateTime",
"",
"",
""
],
[
"Quantity",
"Decimal",
"",
"Required",
"Required"
]
]
},
{
"heading": "POST/PUT Credit Notes",
"anchor": "postput-credit-notes",
"summary": "Available Fields for Product",
"rows": [
[
"Property",
"Type",
"Length",
"POST",
"PUT"
],
[
"Guid",
"Guid",
"",
"Optional",
"N/A"
],
[
"ProductCode",
"String",
"100",
"Optional",
"N/A"
]
]
},
{
"heading": "POST/PUT Credit Notes",
"anchor": "postput-credit-notes",
"summary": "Available Fields for Serial Number",
"rows": [
[
"Property",
"Type",
"Length",
"POST",
"PUT"
],
[
"SerialNumber (XML) / Identifier (JSON)",
"String",
"50",
"Required",
"Required"
]
]
},
{
"heading": "Examples for Request PUT /CreditNotes/{CreditNoteGuid}",
"anchor": "examples-for-request-put-creditnotescreditnoteguid",
"summary": "Available Fields for POST/PUT Credit Lines",
"rows": [
[
"Property",
"Type",
"Length",
"POST",
"PUT"
],
[
"Comments",
"String",
"1024",
"",
""
],
[
"BatchNumbers",
"BatchNumber Collection",
"",
"",
""
],
[
"CreditPrice",
"Decimal",
"",
"Required",
"Required"
],
[
"CreditQuantity",
"Decimal",
"",
"Required",
"Required"
],
[
"Guid",
"Guid",
"",
"N/A",
"Required"
],
[
"Product",
"Product",
"",
"Required",
"N/A"
],
[
"Reason",
"String",
"",
"Required",
"Required"
],
[
"Return",
"Boolean",
"",
"Required",
"Required"
],
[
"SerialNumbers",
"SerialNumber Collection",
"",
"",
""
]
]
},
{
"heading": "Examples for Request PUT /CreditNotes/{CreditNoteGuid}",
"anchor": "examples-for-request-put-creditnotescreditnoteguid",
"summary": "Available Fields for Batch Number",
"rows": [
[
"Property",
"Type",
"Length",
"POST",
"PUT"
],
[
"BatchNumber (XML) / Number (JSON)",
"String",
"50",
"Required",
"Required"
],
[
"ExpiryDate",
"Nullable DateTime",
"",
"",
""
],
[
"Quantity",
"Decimal",
"",
"Required",
"Required"
]
]
},
{
"heading": "Examples for Request PUT /CreditNotes/{CreditNoteGuid}",
"anchor": "examples-for-request-put-creditnotescreditnoteguid",
"summary": "Available Fields for Product",
"rows": [
[
"Property",
"Type",
"Length",
"POST",
"PUT"
],
[
"Guid",
"Guid",
"",
"Optional",
"N/A"
],
[
"ProductCode",
"String",
"100",
"Optional",
"N/A"
]
]
},
{
"heading": "Examples for Request PUT /CreditNotes/{CreditNoteGuid}",
"anchor": "examples-for-request-put-creditnotescreditnoteguid",
"summary": "Available Fields for Serial Number",
"rows": [
[
"Property",
"Type",
"Length",
"POST",
"PUT"
],
[
"SerialNumber (XML) / Identifier (JSON)",
"String",
"50",
"Required",
"Required"
]
]
}
],
"filterTables": [
{
"heading": "GET Credit Notes",
"anchor": "get-credit-notes",
"summary": "Available Filters for GET Credit Notes",
"rows": [
[
"Filter",
"Description"
],
[
"creditNumber",
"Returns a single credit note with the specified credit number. If specified, it overrides all other filters."
],
[
"creditStatus",
"Returns credits for the specified status."
],
[
"endDate",
"Returns credits created before a specified date."
],
[
"modifiedSince",
"Returns credits created or edited after a specified date."
],
[
"pageSize",
"Specifies the page size for pagination. Default page size is 200 credits. Note: Requesting large numbers of contacts can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests."
],
[
"startDate",
"Returns credits created after a specified date."
]
]
}
],
"documentationNotes": [
"The Credit Notes resource allows credit notes to be listed and viewed. An individual credit note details can be viewed by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX ) to the URI.",
"Tip: To efficiently retrieve a count of credit notes that match a filter, specify a pageSize of 0: /CreditNotes?creditStatus=Parked&pageSize=0 . The default ordering is by LastModifiedOn descending.",
"Note: GET requests in XML will not include the Sales Order collection for Free Credits.",
"Note: Please note that only ‘FreeCredit’ Credit notes can be created or updated via the API, but any note can be completed with the POST/Complete filter.",
"Note: At a minimum, a valid Guid or CustomerCode is required.",
"Note: At a minimum, a valid Guid or WarehouseCode is required.",
"Note: At a minimum, a valid Guid or ProductCode is required.",
"Note: At a minimum, a valid Guid or ProductCode is required."
]
}Inspect the Procore catalogue and the approval and account requirements while live acceptance is still pending.
Explore Procore →