API - Sales Agreements

Overview

The table behind this API page is the one that contains the sales agreements in Wisefish, often called “Sales Orders” but are not the same as the Sales Orders in standard Business Central. The sales agreements are mainly used as Delivery Agreements. The endpoint also contains Blanket Sales Agreements.

There are 3 endpoints with same properties, but a different fixed filter on Status and can give access to different procedures:

1. Endpoint salesAgreements shows both open and posted agreements.

2. Agreements which are open for changes, because the posting document has not been created: openSalesAgreements

3. Closed agreements. These are non-editable, because the posting document has been created: closedSalesAgreements

The three endpoints do not have exactly the same property list: shippingReferenceType and invoicingStatus are only on salesAgreements, and noOfTradeItemsReserved and noOfPalletsReserved are not on closedSalesAgreements. On closedSalesAgreements the lines (salesAgreementLines) are read-only. See the Field List below.

Data

Field List

The tags show which properties can be given in POST and PATCH requests on salesAgreements and openSalesAgreements. On closedSalesAgreements (GET only) all properties are read-only.

Object Example

{
    "systemId": "db17585a-4eab-f011-b028-e5231dc67468",
    "documentType": "Delivery",
    "documentNo": "DS-034",
    "orderDate": "2026-01-22",
    "salesPersonCode": "JR",
    "externalDocumentNo": "",
    "status": "Open",
    "sellToCustomerNo": "01905899",
    "sellToCustomerName": "Elkhorn Airport",
    "sellToAddress": "105 Buffalo Dr.",
    "sellToPostCode": "CA-MB R0M 0N0",
    "sellToCity": "Elkhorn",
    "sellToCountryRegion": "CA",
    "sellToContact": "Mr. Ryan Danner",
    "yourReference": "",
    "languageCode": "ENC",
    "locationCode": "BLUE",
    "stockCenterCode": "OWN",
    "transportMethodCode": "",
    "shipmentMethod": "EXW",
    "shipmentDate": "2026-01-22",
    "requestedDeliveryDate": "2026-01-22",
    "placeOfLoading": "",
    "placeOfDischarge": "",
    "placeOfDelivery": "",
    "placeOfDestination": "",
    "shippingAgent": "",
    "shippingAgentService": "",
    "shippingReferenceType": "_x0020_",
    "shippingReferenceNo": "",
    "scheduledTripNo": "",
    "transportUnitId": 0,
    "noOfTransportUnits": 0,
    "shipToCode": "",
    "shipToName": "Elkhorn Airport",
    "shipToName2": "",
    "shipToAddress": "105 Buffalo Dr.",
    "shipToAddress2": "",
    "shipToPostCode": "CA-MB R0M 0N0",
    "shipToCity": "Elkhorn",
    "shipToCounty": "",
    "shipToCountry": "CA",
    "shipToContact": "Mr. Ryan Danner",
    "amount": 31351.86,
    "currencyCode": "CAD",
    "postingDate": "2026-01-22",
    "billToCustomerNo": "01905899",
    "billToCountryRegion": "CA",
    "paymentBankAccount": "",
    "invoicingStatus": "Unavailable for Invoicing and Documentation",
    "noOfLines": 0,
    "noOfTradeItems": 1706,
    "noOfTradeItemsReserved": 1726,
    "noOfTradeItemsShipped": 0,
    "noOfPalletsReserved": 12,
    "systemRowVersion": 2583127,
    "lastModified": "2025-10-29T11:55:38.107Z",
    "modifiedByUser": ""
}

Extended Texts

The child array extendedTexts (object extendedText, page WiFiAPIs ExtendedText) contains the extended texts of the agreement, from table WiFi Document Ext. Text. It has no page of its own in this space and is only available with $expand=extendedTexts on all three endpoints. Extended texts can be added and changed, but not deleted (DeleteAllowed = false).

The link to the agreement is only on documentNo (not on the document type), so extended texts of other document types with the same document no. are also shown.

PDF Document

The code of closedSalesAgreements contains a child object pdfDocument (page WiFiXX PDF Document, one PDF document per agreement, linked on the systemId of the agreement), but it is commented out, so pdfDocument is not available on any of the endpoints and $expand=pdfDocument returns an error. The page WiFiXX PDF Document does not exist in the Wisefish APIs code.

Procedures

In general, if the request is successful, the response is 200 OK and could also possibly contain something in the value property:

{
    "@odata.context": "https://api.businesscentral.dynamics.com/v2.0/b33a6a3b-244c-4295-84b3-0ad90823c736/AB_Test_191125/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Success"
}

Procedure names and parameter names are case-sensitive (e.g. reOpen, AddNote). Each procedure returns a text message in the value property of the response on success. On failure it returns an error with a readable message.

Procedures on salesAgreements

All procedures below are available on salesAgreements. The ones that are also available on openSalesAgreements are marked so in the table above. The URLs may use either of the two endpoints.

Release

This will release the agreement, same as clicking on the Release button within BC.

POST
[server]/api/wisefish/base/v1.0/companies([CompanyGUID])/openSalesAgreements([record-id])/Microsoft.NAV.release

(no parameters)

Possible errors:

• The agreement does not exist (standard Business Central error, record not found).

• The status of the agreement is not Open (standard Business Central error from TestField: Status must be equal to Open).

• Errors from the Wisefish release of the agreement, i.e. the same checks as when the agreement is released in Business Central.

Reopen

If an already released agreement needs to be reopened, in order to do some changes.

POST
[server]/api/wisefish/base/v1.0/companies([CompanyGUID])/openSalesAgreements([record-id])/Microsoft.NAV.reOpen

(no parameters)

Possible errors:

• The agreement does not exist (standard Business Central error, record not found).

• The status of the agreement is not Released (standard Business Central error from TestField: Status must be equal to Released).

• Errors from the Wisefish reopening of the agreement.

Behaviour notes:

• The procedure name is reOpen (capital O). Microsoft.NAV.reopen is not found.

Create Posting Document

When all lines have been registered on the sales agreement, the posting document can be created, i.e. either a Sales Order or a Sales Invoice. Before this is run, the agreement must be released.

POST
[server]/api/wisefish/base/v1.0/companies([CompanyGUID])
  /openSalesAgreements([record-id])/Microsoft.NAV.createPostingDocument

(no parameters)

Possible errors:

• The agreement does not exist (standard Business Central error, record not found).

• Sales document was not created (when no sales document was created, e.g. when the field Sales Document Type on the agreement is not Order or Invoice)

• Errors from the Wisefish creation of the sales document.

Behaviour notes:

• The field Sales Document Type on the agreement decides which document is created: Order creates a Sales Order, Invoice creates a Sales Invoice.

• The API code does not check the status of the agreement before calling Wisefish; status requirements come from the Wisefish document creation.

• The <Document Type> in the response is the caption of the document type (e.g. Order) in the language of the API user.

Set Quantity as Reserved

Sets the quantity on all item lines of the agreement to the quantity that has been reserved, e.g. after pallets or trade items have been reserved to the agreement.

POST
.../salesAgreements([record-id])/Microsoft.NAV.setQuantityAsReserved

(no parameters)

Possible errors:

• The agreement does not exist (standard Business Central error, record not found).

• Cannot modify quantity for a closed sales agreement! (when the status is Closed; this can only happen on salesAgreements)

• Errors from the Wisefish synchronization of the line quantity, or from modifying the lines.

Behaviour notes:

• If the agreement is Released, the status is set to Open while the lines are changed and back to Released afterwards. This is done directly on the status field, the Wisefish release/reopen logic is not run.

• Lines of other types than Item, and lines without an item no., are skipped.

• Only the status Closed is rejected; agreements with status Posting are not blocked by the API code.

Create Posting Document and Post Shipment

This method can be used if the API user is allowed to both create the posting document and then immediately post the items out of inventory.

POST
[server]/api/wisefish/base/v1.0/companies([CompanyGUID])
  /openSalesAgreements([record-id])/Microsoft.NAV.createPostingDocumentAndPostShipment

(no parameters)

Possible errors:

• The agreement does not exist (standard Business Central error, record not found).

• Sales document was not created (when no sales document was created)

• This function only supports Sales Orders! (when the field Sales Document Type on the agreement is Invoice, i.e. a Sales Invoice would be created)

• Errors from the Wisefish creation of the sales document.

• Errors from the standard Business Central posting of the sales order (Sales-Post).

Behaviour notes:

• The whole request is one transaction: if an error occurs, nothing is created or posted (the created sales document is rolled back).

• The <No.> in the response is the number of the sales order that was created and posted.

Set Ready to Be Invoiced

Sets the invoicing status (invoicingStatus) of a released agreement to Ready. This must be done after the agreement has been released. Only available on salesAgreements.

POST
.../salesAgreements([record-id])/Microsoft.NAV.setReadyToBeInvoiced

(no parameters)

Possible errors:

• The agreement does not exist (standard Business Central error, record not found).

• The status of the agreement is not Released (standard Business Central error from TestField: Status must be equal to Released).

Behaviour notes:

• The current invoicing status is not checked, the status is set to Ready whatever it was before.

• The field is changed directly, without running the validation or modify triggers.

Add Note

The procedure AddNote adds a note to the sales agreement. The note is a Business Central Note record link with the description “Sent through API”, and it is registered as from the API user (the user making the call). Only available on salesAgreements.

POST
.../salesAgreements([record-id])/Microsoft.NAV.AddNote

Body:
{
    "noteText": [the text of the note]
}

Possible errors:

• The agreement does not exist (standard Business Central error, record not found).

• noteText is longer than 250 characters (standard Business Central error, the text exceeds the parameter length).

Behaviour notes:

• The note text is not validated: an empty noteText is not rejected, an empty note is added.

• The note is a Note type record link with the description “Sent through API”, created with the current date and time.

Notes can be read with the Record Notes API, see API - Record Notes in this space.

Add Note from a User

The procedure AddNoteFromUser works the same way as AddNote, but the note is registered as from the given Business Central user instead of the API user. Only available on salesAgreements.

POST
.../salesAgreements([record-id])/Microsoft.NAV.AddNoteFromUser

Body:
{
    "noteText": [the text of the note],
    "fromUser": [the BC user ID the note is registered from]
}

Possible errors:

• The agreement does not exist (standard Business Central error, record not found).

• A parameter is longer than its maximum length (standard Business Central error, the text exceeds the parameter length).

• User with ID <fromUser> does not exist (when fromUser is not found in User Setup)

Behaviour notes:

• fromUser is a code parameter, so the value is converted to upper case: "john" is registered and returned as JOHN.

• If fromUser is empty, no user check is made and the note is registered as from the API user (same as AddNote), but the response text then ends with an empty user ID: Note successfully added and registered from user .

• The note text is not validated: an empty noteText is not rejected.

Procedures on openSalesAgreements

The endpoint openSalesAgreements has the procedures release, reOpen, setQuantityAsReserved, createPostingDocument and createPostingDocumentAndPostShipment. They run exactly the same code as on salesAgreements, see Release, Reopen, Set Quantity as Reserved, Create Posting Document and Create Posting Document and Post Shipment above. Only the endpoint in the URL differs:

POST
[server]/api/wisefish/base/v1.0/companies([CompanyGUID])/openSalesAgreements([record-id])/Microsoft.NAV.[procedureName]

Because of the fixed filter on Status, the procedures can only be called on agreements with the status Open, Released, Partly Delivered or Fully Delivered; other agreements are not found. setReadyToBeInvoiced, AddNote and AddNoteFromUser are not available on this endpoint.

Procedures on closedSalesAgreements

The endpoint closedSalesAgreements is read-only and has no procedures.

Examples

Read sales agreements

Read the open agreements of a customer

Reads all open agreements (status Open, Released, Partly Delivered or Fully Delivered) for customer 01905899. The response is a list of agreement objects, as shown in Object Example.

GET .../openSalesAgreements?$filter=sellToCustomerNo eq '01905899'

Read released agreements with selected properties

Reads the released agreements, and returns only a few properties with $select.

Request:

GET .../salesAgreements?$filter=status eq 'Released'&$select=documentNo,sellToCustomerNo,shipmentDate,amount

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/salesAgreements(documentNo,sellToCustomerNo,shipmentDate,amount)",
    "value": [
        {
            "@odata.etag": "W/\"JzIwOzE0Njc0NjI1MTg3MTc1MjQzNTY1MTswMDsn\"",
            "documentNo": "DS-035",
            "sellToCustomerNo": "01905899",
            "shipmentDate": "2026-01-29",
            "amount": 18240.5
        }
    ]
}

Read one agreement with lines

Reading one entry of this table must be done with the record Id which is in this case the systemId.

Lines are shown by adding to the URL $expand=salesAgreementLines

GET ... salesAgreements([system-id])?$expand=salesAgreementLines

GET ... salesAgreements(db17585a-4eab-f011-b028-e5231dc67468)?$expand=salesAgreementLines

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/salesAgreements",
    "value": [
        {
            "@odata.etag": "W/\"JzIwOzE0Njc0NjI1MTg3MTc1MjQzNTY1MTswMDsn\"",
            "systemId": "db17585a-4eab-f011-b028-e5231dc67468",
            "documentType": "Delivery",
            "documentNo": "DS-034",
            "orderDate": "2026-01-22",
            "salesPersonCode": "JR",
            "externalDocumentNo": "",
            "status": "Open",
            "sellToCustomerNo": "01905899",
            "sellToCustomerName": "Elkhorn Airport",
            "sellToAddress": "105 Buffalo Dr.",
            "sellToPostCode": "CA-MB R0M 0N0",
            "sellToCity": "Elkhorn",
            "sellToCountryRegion": "CA",
            "sellToContact": "Mr. Ryan Danner",
            "yourReference": "",
            "languageCode": "ENC",
            "locationCode": "BLUE",
            "stockCenterCode": "OWN",
            "transportMethodCode": "",
            "shipmentMethod": "EXW",
            "shipmentDate": "2026-01-22",
            "requestedDeliveryDate": "2026-01-22",
            "placeOfLoading": "",
            "placeOfDischarge": "",
            "placeOfDelivery": "",
            "placeOfDestination": "",
            "shippingAgent": "",
            "shippingAgentService": "",
            "shippingReferenceType": "_x0020_",
            "shippingReferenceNo": "",
            "scheduledTripNo": "",
            "transportUnitId": 0,
            "noOfTransportUnits": 0,
            "shipToCode": "",
            "shipToName": "Elkhorn Airport",
            "shipToName2": "",
            "shipToAddress": "105 Buffalo Dr.",
            "shipToAddress2": "",
            "shipToPostCode": "CA-MB R0M 0N0",
            "shipToCity": "Elkhorn",
            "shipToCounty": "",
            "shipToCountry": "CA",
            "shipToContact": "Mr. Ryan Danner",
            "amount": 31351.86,
            "currencyCode": "CAD",
            "postingDate": "2026-01-22",
            "billToCustomerNo": "01905899",
            "billToCountryRegion": "CA",
            "paymentBankAccount": "",
            "invoicingStatus": "Unavailable for Invoicing and Documentation",
            "noOfLines": 0,
            "noOfTradeItems": 1706,
            "noOfTradeItemsReserved": 1726,
            "noOfTradeItemsShipped": 0,
            "noOfPalletsReserved": 12,
            "systemRowVersion": 2583127,
            "lastModified": "2025-10-29T11:55:38.107Z",
            "modifiedByUser": "",
            "salesAgreementLines": [
                {
                    "@odata.etag": "W/\"JzE5OzUzOTcwNzA0OTkxNTcwMDI1ODIxOzAwOyc=\"",
                    "systemId": "6cdaab72-80af-f011-b028-99c8bc4e8b83",
                    "documentType": "Delivery",
                    "documentNo": "DS-034",
                    "lineNo": 50000,
                    "type": "Item",
                    "itemNo": "70064",
                    "description": "Cod - raw material",
                    "locationCode": "BLUE",
                    "stockCenterCode": "",
                    "lotFilter": "",
                    "lotFilterOriginal": "",
                    "noOfTradeItems": 1100,
                    "tradeItemUnit": "KG",
                    "quantity": 1100,
                    "unitOfMeasureCode": "KG",
                    "quantityBase": 1100,
                    "noOfPallets": 4.4,
                    "unitPrice": 12,
                    "purchPriceToVendor": 0,
                    "lineAmount": 13200,
                    "lineDiscount": 0,
                    "lineDiscountAmount": 0,
                    "amount": 13200,
                    "vat": 0,
                    "amountIncludingVAT": 13200,
                    "vendorNo": "",
                    "externalProducer": "",
                    "netWeight": 1,
                    "netWeightBWU": 1100,
                    "lastModified": "2025-12-07T09:14:20.323Z"
                },
                {
                    "@odata.etag": "W/\"JzIwOzE0NTI4MDI2MDc2NzYyMzU0Mjc0MTswMDsn\"",
                    "systemId": "de661423-7eaf-f011-b028-99c8bc4e8b83",
                    "documentType": "Delivery",
                    "documentNo": "DS-034",
                    "lineNo": 40000,
                    "type": "Item",
                    "itemNo": "70065",
                    "description": "Fiskinaggar ",
                    "locationCode": "BLUE",
                    "stockCenterCode": "",
                    "lotFilter": "",
                    "lotFilterOriginal": "",
                    "noOfTradeItems": 60,
                    "tradeItemUnit": "PACK",
                    "quantity": 600,
                    "unitOfMeasureCode": "PCS",
                    "quantityBase": 600,
                    "noOfPallets": 0,
                    "unitPrice": 23.153,
                    "purchPriceToVendor": 0,
                    "lineAmount": 13891.8,
                    "lineDiscount": 0,
                    "lineDiscountAmount": 0,
                    "amount": 13891.8,
                    "vat": 0,
                    "amountIncludingVAT": 13891.8,
                    "vendorNo": "",
                    "externalProducer": "",
                    "netWeight": 5,
                    "netWeightBWU": 3000,
                    "lastModified": "2025-10-28T09:30:22.037Z"
                },
                {
                    "@odata.etag": "W/\"JzIwOzEzMDk3OTUxNTU1NTc2NTExMzM4MTswMDsn\"",
                    "systemId": "ee6619e4-66af-f011-b028-99c8bc4e8b83",
                    "documentType": "Delivery",
                    "documentNo": "DS-034",
                    "lineNo": 30000,
                    "type": "Item",
                    "itemNo": "0900",
                    "description": "Þorskflök",
                    "locationCode": "BLUE",
                    "stockCenterCode": "",
                    "lotFilter": "",
                    "lotFilterOriginal": "",
                    "noOfTradeItems": 0,
                    "tradeItemUnit": "BOX",
                    "quantity": 0,
                    "unitOfMeasureCode": "KG",
                    "quantityBase": 0,
                    "noOfPallets": 0,
                    "unitPrice": 17.365,
                    "purchPriceToVendor": 0,
                    "lineAmount": 0,
                    "lineDiscount": 0,
                    "lineDiscountAmount": 0,
                    "amount": 0,
                    "vat": 0,
                    "amountIncludingVAT": 0,
                    "vendorNo": "",
                    "externalProducer": "",
                    "netWeight": 1,
                    "netWeightBWU": 0,
                    "lastModified": "2025-10-28T09:30:22.033Z"
                },
                {
                    "@odata.etag": "W/\"JzE5Ozk1MDA1MzM4ODI5MTk0NTk3NzQxOzAwOyc=\"",
                    "systemId": "dcdc0f4c-a1ad-f011-b028-a35a9231a4e1",
                    "documentType": "Delivery",
                    "documentNo": "DS-034",
                    "lineNo": 20000,
                    "type": "Item",
                    "itemNo": "70079",
                    "description": "Cod fillets (3 kg box)",
                    "locationCode": "BLUE",
                    "stockCenterCode": "",
                    "lotFilter": "",
                    "lotFilterOriginal": "",
                    "noOfTradeItems": 86,
                    "tradeItemUnit": "BOX",
                    "quantity": 86,
                    "unitOfMeasureCode": "BOX",
                    "quantityBase": 258,
                    "noOfPallets": 3.58333333333333333,
                    "unitPrice": 0,
                    "purchPriceToVendor": 0,
                    "lineAmount": 0,
                    "lineDiscount": 0,
                    "lineDiscountAmount": 0,
                    "amount": 0,
                    "vat": 0,
                    "amountIncludingVAT": 0,
                    "vendorNo": "",
                    "externalProducer": "",
                    "netWeight": 3,
                    "netWeightBWU": 258,
                    "lastModified": "2025-10-29T13:57:59.087Z"
                },
                {
                    "@odata.etag": "W/\"JzE5OzQ1ODI2MDIxNDExNjU2NzQ1NDAxOzAwOyc=\"",
                    "systemId": "03591d61-4eab-f011-b028-e5231dc67468",
                    "documentType": "Delivery",
                    "documentNo": "DS-034",
                    "lineNo": 10000,
                    "type": "Item",
                    "itemNo": "70066",
                    "description": "Fish junk (fiskimauk í nagga)",
                    "locationCode": "BLUE",
                    "stockCenterCode": "",
                    "lotFilter": "",
                    "lotFilterOriginal": "",
                    "noOfTradeItems": 460,
                    "tradeItemUnit": "KG",
                    "quantity": 460,
                    "unitOfMeasureCode": "KG",
                    "quantityBase": 460,
                    "noOfPallets": 1.84,
                    "unitPrice": 9.261,
                    "purchPriceToVendor": 0,
                    "lineAmount": 4260.06,
                    "lineDiscount": 0,
                    "lineDiscountAmount": 0,
                    "amount": 4260.06,
                    "vat": 0,
                    "amountIncludingVAT": 4260.06,
                    "vendorNo": "",
                    "externalProducer": "",
                    "netWeight": 1,
                    "netWeightBWU": 460,
                    "lastModified": "2025-10-20T10:41:05.663Z"
                }
            ]
        }
    ]
}

Read an agreement with its extended texts

Adds the extended texts of agreement DS-034 to the response with $expand=extendedTexts (the agreement properties are shortened here).

Request:

GET .../salesAgreements(db17585a-4eab-f011-b028-e5231dc67468)?$expand=extendedTexts

Response (shortened):

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/salesAgreements(extendedTexts())/$entity",
    "systemId": "db17585a-4eab-f011-b028-e5231dc67468",
    "documentType": "Delivery",
    "documentNo": "DS-034",
    "extendedTexts": [
        {
            "@odata.etag": "W/\"JzE5OzEyMzQ1Njc4OTAxMjM0NTY3ODkwOzAwOyc=\"",
            "systemId": "5e0c7a21-4fb0-f011-b028-99c8bc4e8b83",
            "documentType": "Delivery_x0020_Agreement",
            "documentNo": "DS-034",
            "lineNo": 10000,
            "extendedText": "Deliver to gate 4, call before arrival",
            "concatenateLine": false,
            "concatenateLines": false,
            "systemRowVersion": 2583140,
            "lastModified": "2025-10-29T12:02:11.250Z",
            "modifiedByUser": ""
        }
    ]
}

Read closed agreements

Reads the closed agreements (status Posting or Closed) with posting date from 1 January 2026.

GET .../closedSalesAgreements?$filter=postingDate ge 2026-01-01

Create, change and delete agreements

Create an agreement with lines

POST .../openSalesAgreements?$expand=salesAgreementLines

Body:

{
    "orderDate": "2025-12-07",
    "sellToCustomerNo": "4203690429",
    "locationCode": "001",
    "externalDocumentNo": "ORD-0123",
    "salesAgreementLines": [
        {
            "itemNo": "ZZZ1003",
            "noOfTradeItems": 2,
            "tradeItemUnitOfMeasure": "kassi",
            "unitPrice": 10.0
        }
    ]
}

The response contains the new entry, both header and lines.

Change an agreement

Changes the external document no. and the requested delivery date of agreement DS-034. A PATCH request needs the If-Match header with the @odata.etag of the record (or *).

Request:

PATCH .../openSalesAgreements(db17585a-4eab-f011-b028-e5231dc67468)
If-Match: *

Body:
{
    "externalDocumentNo": "ORD-0124",
    "requestedDeliveryDate": "2026-01-25"
}

Response (shortened):

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/openSalesAgreements/$entity",
    "@odata.etag": "W/\"JzIwOzE1MDE4MjM0NTY3ODkwMTIzNDU2MTswMDsn\"",
    "systemId": "db17585a-4eab-f011-b028-e5231dc67468",
    "documentType": "Delivery",
    "documentNo": "DS-034",
    "externalDocumentNo": "ORD-0124",
    "status": "Open",
    "requestedDeliveryDate": "2026-01-25",
    "systemRowVersion": 2583201,
    "lastModified": "2025-10-30T08:14:52.410Z",
    "modifiedByUser": ""
}

Delete an agreement

Deletes agreement DS-034. The same checks apply as when an agreement is deleted in Business Central. On success the response is empty (HTTP status 204 No Content).

DELETE .../openSalesAgreements(db17585a-4eab-f011-b028-e5231dc67468)

Change the status

Release an agreement

Releases agreement DS-034 using release.

Request:

POST
.../openSalesAgreements(db17585a-4eab-f011-b028-e5231dc67468)/Microsoft.NAV.release

(no parameters)

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Agreement has been released"
}

Reopen an agreement

Reopens the released agreement DS-034 using reOpen.

Request:

POST
.../openSalesAgreements(db17585a-4eab-f011-b028-e5231dc67468)/Microsoft.NAV.reOpen

(no parameters)

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Agreement has been reopened"
}

Set an agreement ready to be invoiced

Sets the invoicing status of the released agreement DS-034 to Ready using setReadyToBeInvoiced (only on salesAgreements).

Request:

POST
.../salesAgreements(db17585a-4eab-f011-b028-e5231dc67468)/Microsoft.NAV.setReadyToBeInvoiced

(no parameters)

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Invoicing status set to Ready"
}

Release an agreement that is already released

Calls release on an agreement that is already released; the call fails (the error message is shortened).

Response:

{
    "error": {
        "code": "Internal_TestFieldError",
        "message": "Status must be equal to 'Open'  in Sales Agreement Header: Document Type=Delivery, No.=DS-034. Current value is 'Released'."
    }
}

Reservation and posting

Set the quantity of all lines as reserved

Sets the quantity on all item lines of agreement DS-034 to the reserved quantity using setQuantityAsReserved.

Request:

POST
.../openSalesAgreements(db17585a-4eab-f011-b028-e5231dc67468)/Microsoft.NAV.setQuantityAsReserved

(no parameters)

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Quantity in all lines has been set the same as reserved quantity."
}

Create the posting document for an agreement

Creates the posting document for the released agreement DS-034 using createPostingDocument; here the agreement creates a Sales Order.

Request:

POST
.../openSalesAgreements(db17585a-4eab-f011-b028-e5231dc67468)/Microsoft.NAV.createPostingDocument

(no parameters)

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Sales document Order 101005 created."
}

Create the sales order and post it

Creates a Sales Order for agreement DS-034 and posts it using createPostingDocumentAndPostShipment.

Request:

POST
.../openSalesAgreements(db17585a-4eab-f011-b028-e5231dc67468)/Microsoft.NAV.createPostingDocumentAndPostShipment

(no parameters)

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Sales order 101006 created and shipment posted successfully."
}

Add notes

Add a Note to a Sales Agreement

Adds the note “Customer asked for early delivery” to agreement DS-034 with AddNote; the note is registered as from the API user.

Request:

POST
.../salesAgreements(db17585a-4eab-f011-b028-e5231dc67468)/Microsoft.NAV.AddNote

{
    "noteText": "Customer asked for early delivery"
}

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Note successfully added"
}

Add a Note to a Sales Agreement from a specific User

Adds the same note to agreement DS-034 with AddNoteFromUser, registered as from user JOHN.

Request:

POST
.../salesAgreements(db17585a-4eab-f011-b028-e5231dc67468)/Microsoft.NAV.AddNoteFromUser

{
    "noteText": "Customer asked for early delivery",
    "fromUser": "JOHN"
}

Response:

{
    "@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#Edm.String",
    "value": "Note successfully added and registered from user JOHN"
}