Suppliers

Queryable, Introduced in version 2.18

GET https://localhost:8001/sv/001.1/api/v1/Purchase/Suppliers

Represents a supplier.

GUID

42A7D204-268F-4AC0-9912-8341107A9A2D

Required permission

Show supplier

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the supplier.
SupplierCode String The human readable code of the supplier.
Name String The name of the supplier.
AlternativeName String The alternative name of the supplier.

  • Max length is 100
 Introduced in version 2.28
MailingAddressId Int64? The business key identifier of the supplier mailing address.

References Addresses
 Introduced in version 2.28
MailingAddress Addresses The mailing address of then supplier.

  • Expandable
 Introduced in version 2.28
CorporationIdentificationNumber String The corporation identification number of the supplier.
VatNumber String The VAT number of the supplier.
ServiceTaxNumber String The service tax number of the supplier.

  • Max length is 30
 Introduced in version 2.28
PersonalNumber String The name of private person if is private supplier enabled.
 Introduced in version 23.9
PackingTermId Int64? The business key identifier of the supplier packing term.

References
PackingTerm PackingTerms The packing term of the supplier.

  • Expandable
 Introduced in version 2.28
GracePeriodOrderConfirmation Int32? The grace period order confirmation of the supplier.
 Introduced in version 2.28
GracePeriodDelivery Int32? The grace period delivery of the supplier.
 Introduced in version 2.28
InvoiceSupplierId Int64 The business key identifier of the supplier invoice supplier.

References Suppliers
AuthorizedSignerPersonId Int64? The business key identifier of the supplier authorized signer person.

References Persons
 Introduced in version 2.28
AuthorizedSignerPerson Persons The authorized signer person of the supplier.

  • Expandable
 Introduced in version 2.28
BankIdNumber String The bank id number of the supplier.
CentralBankCode String The central bank code of the supplier.

  • Max length is 3
 Introduced in version 2.28
ResponseTimeId Int64? The business key identifier of the supplier response time.

References
Introduced in version 2.28
ResponseTime ResponseTimes The response time of the supplier.

  • Expandable
 Introduced in version 2.28
InvoiceBasisException Boolean The invoice basis exception of the supplier.
 Introduced in version 2.28
Role Int32 The role of the supplier.

  • MaterialSupplier: 1
  • SubContractor: 2
  • ShippingAgent: 4
  • Miscelaneous: 8
  • CustomsSupplier: 16

  • Bitmask
 Introduced in version 2.28
AttachDatafileWithOrder Boolean Specifies if the supplier have attached datafile with order.
 Introduced in version 2.28
AttachDatafileWithDeliverySchedule Boolean Specifies if the supplier have attached datafile with delivery schedule.
 Introduced in version 22.2
AttachDatafileWithCase Boolean Specifies if the supplier have attached datafile with case.
 Introduced in version 22.2
ReceivingInspectionType Int32 The receiving inspection type of the supplier.

  • None: 0
  • Always: 1
  • VariableInspection: 2
 Introduced in version 2.28
ArrivalReportingInstructionId Int64? The business key identifier of the supplier arrival reporting instruction.

References
Introduced in version 2.28
ArrivalReportingInstruction Comments The arrival reporting instruction of the supplier.

  • Expandable
 Introduced in version 2.28
UseOCRNumber Boolean Specifies if the supplier use OCR number.
 Introduced in version 2.28
UseReferenceNumber Boolean Specifies if the supplier use reference number.
 Introduced in version 2.28
FixedReferenceNumber String The fixed reference number of the supplier.

  • Max length is 20
 Introduced in version 2.28
EInvoiceId String The e-invoice id of the supplier.

  • Max length is 30
 Introduced in version 2.28
PurchaseManagerId Int64? The business key identifier of the supplier purchase manager.

References Persons
 Introduced in version 2.28
PurchaseManager Persons The purchase manager of the supplier.

  • Expandable
 Introduced in version 2.28
ShippingAgentCode String The shipping agent code of the supplier.

  • Max length is 15
 Introduced in version 2.28
DefaultBusinessContactBankAccountId Int64? The business key identifier of the supplier default business contact bank account.

References BusinessContactBankAccounts
 Introduced in version 2.28
DefaultBusinessContactBankAccount BusinessContactBankAccounts The default business contact bank account of the supplier.

  • Expandable
 Introduced in version 2.28
IsCasualSupplier Boolean Specifies if the supplier is a casual supplier.
 Introduced in version 2.28
ShippingAgentType Int32? The shipping agent type of the supplier.

  • Other: 0
  • DHL: 1
  • Schenker: 2
  • PostNord: 3
  • DSV: 4
 Introduced in version 2.28
BookTransport Boolean The book transport of the supplier.
 Introduced in version 2.28
ReturnLabel Boolean The return label of the supplier.
 Introduced in version 2.28
ShipmentPrintSetting Int32 The shipment print setting of the supplier.

  • WaybillAndParcel: 0
  • Waybill: 1
  • Parcel: 2
 Introduced in version 2.28
Url String The URL of the supplier.
Discount Decimal? The discount of the supplier.
StatusId Int64 The business key identifier of the supplier status.

References SupplierStatuses
Status SupplierStatuses The status of the supplier.

  • Expandable
 Introduced in version 2.28
TypeId Int64? The business key identifier of the supplier type.

References SupplierTypes
Type SupplierTypes The type of the supplier.

  • Expandable
 Introduced in version 2.28
DistrictId Int64? The business key identifier of the supplier district.

References SupplierDistricts
District SupplierDistricts The district of the supplier.

  • Expandable
 Introduced in version 2.28
PayViaId Int64? The business key identifier of the supplier that the current supplier payments
should go through.

References Suppliers
DateForTransitionToActualContact DateTimeOffset The date for transition to actual contact of the supplier.
 Introduced in version 2.28
PaymentTermId Int64 The business key identifier of the supplier payment term

References
Introduced in version 2.28
PaymentTerm PaymentTerms The payment term of the supplier.
 Introduced in version 2.28
BankGiroNo String The bank giro no of the supplier.

  • Max length is 15
 Introduced in version 2.28
EdiCode String The EDI code of the supplier.

  • Obsolete since version 2.32 (Replaced by OtherSupplierNumbers)
  • Max length is 20
 Introduced in version 2.28
DefaultOrderPrintoutVia Int32 The default order printout via of the supplier.

  • Printer: 0
  • Email: 1
  • Edi: 2
  • None: 9
 Introduced in version 2.28
PlusGiroNo String The plus giro number of the supplier.

  • Max length is 15
 Introduced in version 2.28
OurCodeByYou String The human readable identifier that the the supplier uses to identify the current company.

  • Max length is 20
 Introduced in version 2.28
DiscountCategoryId Int64? The business key identifier of the supplier discount category.

References
Introduced in version 2.28
DiscountCategory DiscountCategories The discount category of the supplier.

  • Expandable
 Introduced in version 2.28
ToleranceForEarlyDelivery Int64? The tolerance value for early delivery by the supplier.
ToleranceForLateDelivery Int64? The tolerance value for late delivery by the supplier.
Alias String The alias of the supplier.

  • Max length is 10
 Introduced in version 2.28
BlockedContextType Int32 The blocked context type of the supplier.

  • None: 0
  • Register: 1
  • Report: 2
  • RegisterSupplierInvoice: 4
  • Payments: 8

  • Bitmask
 Introduced in version 2.28
IsInternal Boolean Specifies if the supplier is internal.
 Introduced in version 2.28
CompanyId Int64 The business key identifier of the company that the supplier data is
active for.

References Company
BlockedStatus Int32 The block status of the entity.

  • None: 0
  • Message: 1
  • Blocked: 2
BlockedFromDate DateTimeOffset? The date when the entity starts being blocked.
BlockedToDate DateTimeOffset? The date when the entity stops being blocked.
Priority Int32 The priority of the supplier.
CategoryString String The category string of the supplier.
DeliveryInstruction String The delivery instruction of the supplier.
PaymentMethodId Int64 The business key identifier of the supplier payment method.

References PaymentMethods
LastChange DateTimeOffset? Last change on Supplier från EntityChangeLog
 Introduced in version 2.26
PaymentMethod PaymentMethods The payment method of the supplier.

  • Expandable
LanguageId Int64 The business key identifier of the supplier language.

References LanguageCodes
Language LanguageCodes The language of the supplier.

  • Expandable
CommentId Int64? The business key identifier of the supplier comment.

References Comments
Comment Comments The supplier comment.

  • Expandable
CurrencyId Int64 The business key identifier of the supplier currency.

References Currencies.
Currency Currencies The currency of the supplier.

  • Expandable
VisitingAddressId Int64? The business key identifier of the supplier visiting address.

References Addresses
VisitingAddress Addresses The visiting address of the supplier.

  • Expandable
BlockMessageId Int64? The business key identifier of the entity block message comment.

References Comments.
BlockMessage Comments The block message of the supplier.

  • Expandable
BlockedById Int64? The business key identifier of the application user that blocked the entity.
BlockedBy ApplicationUsers The application user that blocked the supplier.

  • Expandable
DefaultReferenceId Int64? The business key identifier of the default reference of the supplier.

References BusinessContactReferences
DefaultReference BusinessContactReferences The default reference of the supplier.

  • Expandable
DeliveryAddressId Int64 The business key identifier of the supplier delivery address.

References
Introduced in version 2.28
DeliveryAddress DeliveryAddresses The delivery address of the supplier.

  • Expandable
SupplierPartLinks SupplierPartLinks[] A collection of supplier part links that belong to the supplier.

  • Expandable
CaseEntries CaseEntry[] A collection of case entries that belong to the supplier.

  • Expandable
OtherSupplierNumbers OtherSupplierNumbers[] Available other supplier numbers. Mainly used as EDI identifiers.

  • Expandable
 Introduced in version 2.32
CommunicationAddresses CommunicationAddresses[] The communication addresses for the supplier.

  • Expandable
 Introduced in version 2.52
ExtraFields ExtraFields[] A collection of extra field values for the supplier.

  • Expandable
 Introduced in version 2.54
PurchaseAccountId Int64? The business key identifier of the coding entry with supplier purchase account.

 Introduced in version 22.7
PurchaseAccount CodingEntries The coding entry with supplier purchase account.

  • Expandable
 Introduced in version 22.7
AccrualAccountingReverseAccountId Int64? The business key identifier of the coding entry with supplier offset account for accruals.

 Introduced in version 22.7
AccrualAccountingReverseAccount CodingEntries The coding entry with supplier offset account for accruals.

  • Expandable
 Introduced in version 22.7
OutgoingPaymentsAccountId Int64? The business key identifier of the coding entry with supplier account for outgoing payments.

 Introduced in version 22.7
OutgoingPaymentsAccount CodingEntries The coding entry with supplier account for outgoing payments.

  • Expandable
 Introduced in version 22.7
SupplierAccounts SupplierAccounts[] The supplier account exceptions.

  • Expandable
 Introduced in version 22.7
CurrencyExchangeTypeId Int64 The business key identifier of the supplier's currency exchange type.

 Introduced in version 22.9
RootId Int64 The business key identifier of the supplier root id.

  • References SupplierRoot
 Introduced in version 23.9
References BusinessContactReferences[] The business contact references belonging to the supplier.

  • Expandable
 Introduced in version 23.9
ReceivingInspecionFromDate DateTimeOffset? The receiving inspection from date for supplier.
 Introduced in version 23.9
ReceivingInspecionEndDate DateTimeOffset? The receiving inspection end date for supplier.
 Introduced in version 23.9
SupplierAccountGroupId Int64 The business key identifier of the supplier account group for supplier.

 Introduced in version 23.9
IsPrivateSupplier Boolean The private person setting of supplier.
 Introduced in version 23.9
EORINumber String The eori of supplier. mainly used for validation to retrieve business address.
 Introduced in version 23.9
DeliveryAddresses DeliveryAddresses[] All available delivery addresses of the supplier.

 Introduced in version 24.4
AllBusinessContactBankAccountOfSupplier BusinessContactBankAccounts[] All available supplier's business contact bank accounts.
References BusinessContactBankAccounts

  • Expandable
 Introduced in version 25.3
TinNumber String The supplier’s income tax reference number

  • Max length is 13
 Introduced in version 25.9

Example

{
  "Id": 0,
  "SupplierCode": null,
  "Name": null,
  "AlternativeName": null,
  "MailingAddressId": null,
  "MailingAddress": null,
  "CorporationIdentificationNumber": null,
  "VatNumber": null,
  "ServiceTaxNumber": null,
  "PersonalNumber": null,
  "PackingTermId": null,
  "PackingTerm": null,
  "GracePeriodOrderConfirmation": null,
  "GracePeriodDelivery": null,
  "InvoiceSupplierId": 0,
  "AuthorizedSignerPersonId": null,
  "AuthorizedSignerPerson": null,
  "BankIdNumber": null,
  "CentralBankCode": null,
  "ResponseTimeId": null,
  "ResponseTime": null,
  "InvoiceBasisException": false,
  "Role": 0,
  "AttachDatafileWithOrder": false,
  "AttachDatafileWithDeliverySchedule": false,
  "AttachDatafileWithCase": false,
  "ReceivingInspectionType": 0,
  "ArrivalReportingInstructionId": null,
  "ArrivalReportingInstruction": null,
  "UseOCRNumber": false,
  "UseReferenceNumber": false,
  "FixedReferenceNumber": null,
  "EInvoiceId": null,
  "PurchaseManagerId": null,
  "PurchaseManager": null,
  "ShippingAgentCode": null,
  "DefaultBusinessContactBankAccountId": null,
  "DefaultBusinessContactBankAccount": null,
  "IsCasualSupplier": false,
  "ShippingAgentType": null,
  "BookTransport": false,
  "ReturnLabel": false,
  "ShipmentPrintSetting": 0,
  "Url": null,
  "Discount": null,
  "StatusId": 0,
  "Status": null,
  "TypeId": null,
  "Type": null,
  "DistrictId": null,
  "District": null,
  "PayViaId": null,
  "DateForTransitionToActualContact": "0001-01-01T00:00:00+00:00",
  "PaymentTermId": 0,
  "PaymentTerm": null,
  "BankGiroNo": null,
  "EdiCode": null,
  "DefaultOrderPrintoutVia": 0,
  "PlusGiroNo": null,
  "OurCodeByYou": null,
  "DiscountCategoryId": null,
  "DiscountCategory": null,
  "ToleranceForEarlyDelivery": null,
  "ToleranceForLateDelivery": null,
  "Alias": null,
  "BlockedContextType": 0,
  "IsInternal": false,
  "CompanyId": 0,
  "BlockedStatus": 0,
  "BlockedFromDate": null,
  "BlockedToDate": null,
  "Priority": 0,
  "CategoryString": null,
  "DeliveryInstruction": null,
  "PaymentMethodId": 0,
  "LastChange": null,
  "PaymentMethod": null,
  "LanguageId": 0,
  "Language": null,
  "CommentId": null,
  "Comment": null,
  "CurrencyId": 0,
  "Currency": null,
  "VisitingAddressId": null,
  "VisitingAddress": null,
  "BlockMessageId": null,
  "BlockMessage": null,
  "BlockedById": null,
  "BlockedBy": null,
  "DefaultReferenceId": null,
  "DefaultReference": null,
  "DeliveryAddressId": 0,
  "DeliveryAddress": null,
  "SupplierPartLinks": null,
  "CaseEntries": null,
  "OtherSupplierNumbers": null,
  "CommunicationAddresses": null,
  "ExtraFields": null,
  "PurchaseAccountId": null,
  "PurchaseAccount": null,
  "AccrualAccountingReverseAccountId": null,
  "AccrualAccountingReverseAccount": null,
  "OutgoingPaymentsAccountId": null,
  "OutgoingPaymentsAccount": null,
  "SupplierAccounts": null,
  "CurrencyExchangeTypeId": 0,
  "RootId": 0,
  "References": null,
  "ReceivingInspecionFromDate": null,
  "ReceivingInspecionEndDate": null,
  "SupplierAccountGroupId": 0,
  "IsPrivateSupplier": false,
  "EORINumber": null,
  "DeliveryAddresses": null,
  "AllBusinessContactBankAccountOfSupplier": null,
  "TinNumber": null
}