GET SupplierReturn/Get?includeDetail={includeDetail}
Gets a List of Supplier Returns.
Request Information
This method supports OData queries.
URI Parameters
| Name | Type | Additional information | Description |
|---|---|---|---|
| includeDetail | bool |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
This collection is wrapped in a paging response object.
Paging response of Supplier Return| Name | Type | Additional information | Description |
|---|---|---|---|
| TotalResults | integer |
None. |
|
| ReturnedResults | integer |
None. |
|
| Results | Collection of Supplier Return |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalResults": 1,
"ReturnedResults": 2,
"Results": [
{
"FromDocument": "sample string 1",
"Locked": true,
"$TrackingCode": "sample string 3",
"SupplierId": 4,
"SupplierName": "sample string 5",
"Supplier": {
"Name": "sample string 1",
"Category": {
"Description": "sample string 1",
"ID": 2,
"Modified": "2024-11-15",
"Created": "2024-11-15"
},
"TaxReference": "sample string 2",
"ContactName": "sample string 3",
"Telephone": "sample string 4",
"Fax": "sample string 5",
"Mobile": "sample string 6",
"Email": "sample string 7",
"WebAddress": "sample string 8",
"Active": true,
"IsObfuscated": true,
"Balance": 11.0,
"CreditLimit": 12.0,
"PostalAddress01": "sample string 13",
"PostalAddress02": "sample string 14",
"PostalAddress03": "sample string 15",
"PostalAddress04": "sample string 16",
"PostalAddress05": "sample string 17",
"DeliveryAddress01": "sample string 18",
"DeliveryAddress02": "sample string 19",
"DeliveryAddress03": "sample string 20",
"DeliveryAddress04": "sample string 21",
"DeliveryAddress05": "sample string 22",
"AutoAllocateToOldestInvoice": true,
"TextField1": "sample string 23",
"TextField2": "sample string 24",
"TextField3": "sample string 25",
"NumericField1": 1.0,
"NumericField2": 1.0,
"NumericField3": 1.0,
"YesNoField1": true,
"YesNoField2": true,
"YesNoField3": true,
"DateField1": "2024-11-15",
"DateField2": "2024-11-15",
"DateField3": "2024-11-15",
"AccountingAgreement": true,
"HasSpecialCountryTaxActivity": true,
"Modified": "2024-11-15",
"Created": "2024-11-15",
"BusinessRegistrationNumber": "sample string 33",
"RMCDApprovalNumber": "sample string 34",
"TaxStatusVerified": "2024-11-15",
"CurrencyId": 1,
"CurrencySymbol": "sample string 35",
"HasActivity": true,
"DefaultDiscountPercentage": 1.0,
"DefaultTaxTypeId": 1,
"DefaultTaxType": {
"ID": 1,
"Name": "sample string 2",
"Percentage": 3.1,
"IsDefault": true,
"HasActivity": true,
"IsManualTax": true,
"Active": true,
"Created": "2024-11-15",
"Modified": "2024-11-15",
"TaxTypeDefaultUID": "cb7c1410-9702-477d-a67c-1e65bc0b4ead",
"CompanyId": 9
},
"DueDateMethodId": 1,
"DueDateMethodValue": 1,
"SubjectToDRCVat": true,
"ID": 38
},
"Modified": "2024-11-15",
"Created": "2024-11-15",
"StatusId": 1,
"Supplier_CurrencyId": 1,
"Supplier_ExchangeRate": 1.0,
"ID": 7,
"Date": "2024-11-15",
"Inclusive": true,
"DiscountPercentage": 9.1,
"TaxReference": "sample string 10",
"DocumentNumber": "sample string 11",
"Reference": "sample string 12",
"Message": "sample string 13",
"Discount": 14.0,
"Exclusive": 15.0,
"Tax": 16.0,
"Rounding": 17.0,
"Total": 18.0,
"AmountDue": 19.0,
"PostalAddress01": "sample string 20",
"PostalAddress02": "sample string 21",
"PostalAddress03": "sample string 22",
"PostalAddress04": "sample string 23",
"PostalAddress05": "sample string 24",
"DeliveryAddress01": "sample string 25",
"DeliveryAddress02": "sample string 26",
"DeliveryAddress03": "sample string 27",
"DeliveryAddress04": "sample string 28",
"DeliveryAddress05": "sample string 29",
"Printed": true,
"TaxPeriodId": 1,
"Editable": true,
"HasAttachments": true,
"HasNotes": true,
"HasAnticipatedDate": true,
"HasSpecialCountryTax": true,
"AnticipatedDate": "2024-11-15",
"ExternalReference": "sample string 34",
"UID": "8ab7f801-e0e7-4ed9-a55e-c50668326c61",
"Lines": [
{
"SelectionId": 1,
"TaxTypeId": 1,
"ID": 1,
"Description": "sample string 2",
"LineType": 0,
"Quantity": 1.0,
"UnitPriceExclusive": 3.0,
"Unit": "sample string 4",
"UnitPriceInclusive": 5.0,
"TaxPercentage": 6.1,
"DiscountPercentage": 7.1,
"Exclusive": 8.0,
"Discount": 9.0,
"Tax": 10.0,
"Total": 11.0,
"Comments": "sample string 12",
"AnalysisCategoryId1": 1,
"AnalysisCategoryId2": 1,
"AnalysisCategoryId3": 1,
"$TrackingCode": "sample string 13",
"CurrencyId": 1,
"UnitCost": 1.0,
"UID": "26dbe409-7bdb-4256-af24-003d3c74f1ff"
},
{
"SelectionId": 1,
"TaxTypeId": 1,
"ID": 1,
"Description": "sample string 2",
"LineType": 0,
"Quantity": 1.0,
"UnitPriceExclusive": 3.0,
"Unit": "sample string 4",
"UnitPriceInclusive": 5.0,
"TaxPercentage": 6.1,
"DiscountPercentage": 7.1,
"Exclusive": 8.0,
"Discount": 9.0,
"Tax": 10.0,
"Total": 11.0,
"Comments": "sample string 12",
"AnalysisCategoryId1": 1,
"AnalysisCategoryId2": 1,
"AnalysisCategoryId3": 1,
"$TrackingCode": "sample string 13",
"CurrencyId": 1,
"UnitCost": 1.0,
"UID": "26dbe409-7bdb-4256-af24-003d3c74f1ff"
}
]
},
{
"FromDocument": "sample string 1",
"Locked": true,
"$TrackingCode": "sample string 3",
"SupplierId": 4,
"SupplierName": "sample string 5",
"Supplier": {
"Name": "sample string 1",
"Category": {
"Description": "sample string 1",
"ID": 2,
"Modified": "2024-11-15",
"Created": "2024-11-15"
},
"TaxReference": "sample string 2",
"ContactName": "sample string 3",
"Telephone": "sample string 4",
"Fax": "sample string 5",
"Mobile": "sample string 6",
"Email": "sample string 7",
"WebAddress": "sample string 8",
"Active": true,
"IsObfuscated": true,
"Balance": 11.0,
"CreditLimit": 12.0,
"PostalAddress01": "sample string 13",
"PostalAddress02": "sample string 14",
"PostalAddress03": "sample string 15",
"PostalAddress04": "sample string 16",
"PostalAddress05": "sample string 17",
"DeliveryAddress01": "sample string 18",
"DeliveryAddress02": "sample string 19",
"DeliveryAddress03": "sample string 20",
"DeliveryAddress04": "sample string 21",
"DeliveryAddress05": "sample string 22",
"AutoAllocateToOldestInvoice": true,
"TextField1": "sample string 23",
"TextField2": "sample string 24",
"TextField3": "sample string 25",
"NumericField1": 1.0,
"NumericField2": 1.0,
"NumericField3": 1.0,
"YesNoField1": true,
"YesNoField2": true,
"YesNoField3": true,
"DateField1": "2024-11-15",
"DateField2": "2024-11-15",
"DateField3": "2024-11-15",
"AccountingAgreement": true,
"HasSpecialCountryTaxActivity": true,
"Modified": "2024-11-15",
"Created": "2024-11-15",
"BusinessRegistrationNumber": "sample string 33",
"RMCDApprovalNumber": "sample string 34",
"TaxStatusVerified": "2024-11-15",
"CurrencyId": 1,
"CurrencySymbol": "sample string 35",
"HasActivity": true,
"DefaultDiscountPercentage": 1.0,
"DefaultTaxTypeId": 1,
"DefaultTaxType": {
"ID": 1,
"Name": "sample string 2",
"Percentage": 3.1,
"IsDefault": true,
"HasActivity": true,
"IsManualTax": true,
"Active": true,
"Created": "2024-11-15",
"Modified": "2024-11-15",
"TaxTypeDefaultUID": "cb7c1410-9702-477d-a67c-1e65bc0b4ead",
"CompanyId": 9
},
"DueDateMethodId": 1,
"DueDateMethodValue": 1,
"SubjectToDRCVat": true,
"ID": 38
},
"Modified": "2024-11-15",
"Created": "2024-11-15",
"StatusId": 1,
"Supplier_CurrencyId": 1,
"Supplier_ExchangeRate": 1.0,
"ID": 7,
"Date": "2024-11-15",
"Inclusive": true,
"DiscountPercentage": 9.1,
"TaxReference": "sample string 10",
"DocumentNumber": "sample string 11",
"Reference": "sample string 12",
"Message": "sample string 13",
"Discount": 14.0,
"Exclusive": 15.0,
"Tax": 16.0,
"Rounding": 17.0,
"Total": 18.0,
"AmountDue": 19.0,
"PostalAddress01": "sample string 20",
"PostalAddress02": "sample string 21",
"PostalAddress03": "sample string 22",
"PostalAddress04": "sample string 23",
"PostalAddress05": "sample string 24",
"DeliveryAddress01": "sample string 25",
"DeliveryAddress02": "sample string 26",
"DeliveryAddress03": "sample string 27",
"DeliveryAddress04": "sample string 28",
"DeliveryAddress05": "sample string 29",
"Printed": true,
"TaxPeriodId": 1,
"Editable": true,
"HasAttachments": true,
"HasNotes": true,
"HasAnticipatedDate": true,
"HasSpecialCountryTax": true,
"AnticipatedDate": "2024-11-15",
"ExternalReference": "sample string 34",
"UID": "8ab7f801-e0e7-4ed9-a55e-c50668326c61",
"Lines": [
{
"SelectionId": 1,
"TaxTypeId": 1,
"ID": 1,
"Description": "sample string 2",
"LineType": 0,
"Quantity": 1.0,
"UnitPriceExclusive": 3.0,
"Unit": "sample string 4",
"UnitPriceInclusive": 5.0,
"TaxPercentage": 6.1,
"DiscountPercentage": 7.1,
"Exclusive": 8.0,
"Discount": 9.0,
"Tax": 10.0,
"Total": 11.0,
"Comments": "sample string 12",
"AnalysisCategoryId1": 1,
"AnalysisCategoryId2": 1,
"AnalysisCategoryId3": 1,
"$TrackingCode": "sample string 13",
"CurrencyId": 1,
"UnitCost": 1.0,
"UID": "26dbe409-7bdb-4256-af24-003d3c74f1ff"
},
{
"SelectionId": 1,
"TaxTypeId": 1,
"ID": 1,
"Description": "sample string 2",
"LineType": 0,
"Quantity": 1.0,
"UnitPriceExclusive": 3.0,
"Unit": "sample string 4",
"UnitPriceInclusive": 5.0,
"TaxPercentage": 6.1,
"DiscountPercentage": 7.1,
"Exclusive": 8.0,
"Discount": 9.0,
"Tax": 10.0,
"Total": 11.0,
"Comments": "sample string 12",
"AnalysisCategoryId1": 1,
"AnalysisCategoryId2": 1,
"AnalysisCategoryId3": 1,
"$TrackingCode": "sample string 13",
"CurrencyId": 1,
"UnitCost": 1.0,
"UID": "26dbe409-7bdb-4256-af24-003d3c74f1ff"
}
]
}
]
}