Suppliers
A Supplier relationship links your own Organisation (parent) to another Organisation (child), defining that organisation as a supplier to your business. It stores supplier-specific data such as payment terms, price list, and mailing preferences.
Use the Relationship_Organization_Supplier endpoint to manage your suppliers. Suppliers inherit all fields from Relationship and add supplier-specific fields.
A Supplier (Relationship_Organization_Supplier) is a Relationship — it defines the role an organisation plays as a vendor to your business.
An Organisation (Relation_Organization) is the entity itself — the company record. The same Organisation can be both a Supplier and a Customer.
Endpoints
List Suppliers
Retrieve a paginated list of suppliers.
/v1/odata/Relationship_Organization_SupplierSingle Supplier
Retrieve a single supplier by its ID.
/v1/odata/Relationship_Organization_Supplier({id})With expanded relations:
/v1/odata/Relationship_Organization_Supplier({id})?$expand=Organization,RelationCreate Supplier with a New Organisation
Create a supplier relationship and its underlying Organisation in one call:
/v1/odata/Relationship_Organization_SupplierRelation.ID— Your own organisation (parent)Organization— The supplier Organisation fields (created automatically)
Create Supplier from an Existing Organisation
Link an existing Organisation as a supplier:
/v1/odata/Relationship_Organization_SupplierUpdate Supplier
Update an existing supplier relationship. Provide only the fields to update.
/v1/odata/Relationship_Organization_Supplier({id})Delete Supplier
Delete a supplier relationship by ID. This removes the supplier role but does not delete the underlying Organisation.
/v1/odata/Relationship_Organization_Supplier({id})Make sure you do not orphan the Organisation when deleting a Supplier relationship. If it is the only relationship linking that Organisation to your network, consider deleting the Organisation instead.
Fields
Standard Fields (all entities)
| Field | Type | Description |
|---|---|---|
ID | Guid | Primary key (UUID) |
_Type | String | Entity type discriminator (Relationship.Organization.Supplier) |
_Name | String | Computed display name |
SortIndex | Double | Sorting order |
CreationDate | DateTimeOffset | Date the record was created |
LastMutationDate | DateTimeOffset | Date of the last modification |
IsActive | Boolean | Whether the record is active |
IsClosed | Boolean | Whether the record is closed |
Supplier Fields
| Field | Type | Description |
|---|---|---|
Name | String | Supplier display name |
PaymentTermInDays | Double | Payment term in days |
Relationships
| Relationship | Target Entity | Cardinality | Description |
|---|---|---|---|
| Relation | Relation | N:1 | Parent organisation (your company) |
| Organization | Relation.Organization | N:1 | The supplier organisation |
| PriceList | PriceList | N:1 | Assigned price list |
Expanding Relationships
/v1/odata/Relationship_Organization_Supplier({id})?$expand=Organization/v1/odata/Relationship_Organization_Supplier?$expand=Organization,RelationNavigating Relationships
/v1/odata/Relationship_Organization_Supplier({id})/RelationFiltering Examples
/v1/odata/Relationship_Organization_Supplier?$filter=contains(Name, '{Name}')&$top={top}/v1/odata/Relationship_Organization_Supplier?$filter=PaymentTermInDays eq {PaymentTermInDays}&$top={top}/v1/odata/Relationship_Organization_Supplier?$filter=CreationDate gt {CreationDate}&$top={top}/v1/odata/Relationship_Organization_Supplier?$filter=IsClosed eq {IsClosed}&$top={top}Custom Query
Build your own OData query against Relationship_Organization_Supplier. Open Run and edit the whole request inline — swap the entity set, change the $filter, or add $expand, $select, $orderby, $top, $skip. Type $ for suggestions; use ↺ Reset to restore this example.
/v1/odata/Relationship_Organization_Supplier?$top=10