Breadcrumbs

EP API - Sales Agreements

Overview

This API returns the Wisefish sales documents, i.e. Delivery Agreements. It contains also the sales lines as a child array.

Endpoint name

salesAgreementHeaders

Source table in Wisefish

WiFi Sales Agreement Header

Fixed view

There is a fixed filter on

  • Document Type = Delivery

Editable

No data modification possible.

Procedures

There are no procedures on this endpoint.

Primary Key

“Document Type”,”No.”

Data

Field List

Property

Type

Table Field

Field Type

Note

documentType

String

Document Type

Option

The option normally used is: Delivery
List of all options available: OptionMembers = Blanket,Delivery,Internal,Quote,ReceiptWh,ShipmentWh,CreditDA;

no

String

No.

Code[20]


status

String

Status

Option

OptionMembers = Open,Released,"Pending Approval","Pending Prepayment",,,,,Proforma,Posting,Closed,"Fully Delivered","Partly Delivered",Cancelled,Rejected,"Pending Acceptance",Accepted;

sellToCustomerNo

String

Sell-to Customer No.

Code[20]


sellToName

String

Sell-to Customer Name

Text[100]


shipToCode

String

Ship-to Code

Code[10]


shipToName

String

Ship-to Name

Text[100]


shipToNam2

String

Ship-to Name 2

Text[50]


shipToAddress

String

Ship-to Address

Text[100]


shipToAddress2

String

Ship-to Address 2

Text[50]


shipToCity

String

Ship-to City

Text[30]


shipToContact

String

Ship-to Contact

Text[100]


shipToPostCode

String

Ship-to Post Code

Code[20]


shipToCounty

String

Ship-to County

Text[30]


shipToCountryRegionCode

String

Ship-to Country/Region Code

Code[10]


shipmentMethodCode

String

Shipment Method Code

Code[10]


shipmentDate

Date

Shipment Date

Date


shippingAgentCode

String

Shipping Agent Code

Code[10]


shippingAgentServiceCode

String

Shipping Agent Service Code

Code[10]


shippingFacilityCode

String

Shipping Facility Code

Code[20]


shippingReferenceType

String

Shipping Reference Type

Option

OptionMembers = " ",AWB,CONNOTE;

shippingReferenceNo

String

Shipping Reference No.

Code[20]


shippingReferenceConsignee

String

Shipping Reference Consignee

Text


transportMethodCode

String

Transport Method Code

Code[10]


transporter

String

Shipping Agent Code

Code[10]


placeOfDelivery

String

Place of Delivery

Code[10]


placeOfLoading

String

Place of Loading

Code[20]


placeOfDischarge

String

Place of Discharge

Code[20]


placeOfDestination

String

Place of Destination

Code[20]


languageCode

String

Language Code

Code[10]


lastDateModified

Date

Last Date Modified

Date


systemId

String uuid

SystemId

GUID


lastModified

date utc

SystemModifiedAt

DateTime

Note: The name of this field in business central is “systemModifedAt” and it can be seen in page inspection in the user interface.

salesAgreementLines

array



Array of objects from salesAgreementLines API

Example

Expand to see the example json

An example of one object in the list:

JSON
    "value": [
        {
            "@odata.etag": "W/\"JzIwOzEwMTEyODcyOTQzODM2MzAxMTczMTswMDsn\"",
            "systemId": "b3e03317-faed-ef11-aac0-c0b6f9b7cac7",
            "documentType": "Delivery",
            "no": "DEL2005003",
            "status": "Closed",
            "sellToCustomerNo": "1705",
            "sellToName": "FINAL PRODUCT FISHERIES CO.",
            "shipToCode": "",
            "shipToName": "FINAL PRODUCT FISHERIES CO.",
            "shipToNam2": "",
            "shipToAddress": "900 WEST BAKER STREET OF MANHATTAN",
            "shipToAddress2": "",
            "shipToCity": "NEW YORK",
            "shipToContact": "ANDY BRANDY",
            "shipToPostCode": "NY-201",
            "shipToCounty": "USA",
            "shipToCountryRegionCode": "NY",
            "shipmentMethodCode": "FOB",
            "shipmentDate": "2025-12-27",
            "shippingAgentCode": "",
            "shippingAgentServiceCode": "",
            "shippingFacilityCode": "",
            "shippingReferenceType": " ",
            "shippingReferenceNo": "",
            "shippingReferenceConsignee": "",
            "transportMethodCode": "",
            "transporter": "",
            "placeOfDelivery": "USFOX",
            "placeOfLoading": "ISREY",
            "placeOfDischarge": "",
            "placeOfDestination": "USFOX",
            "languageCode": "ENU",
            "lastDateModified": "0001-01-01T00:00:00Z",
            "lastModified": "2025-02-18T15:41:16.647Z"
        }