GET SupplierPayment/Get?includeSupplierDetails={includeSupplierDetails}&includeBankAccountDetails={includeBankAccountDetails}
Gets a list of Supplier Payments.
Request Information
This method supports OData queries.
URI Parameters
| Name | Type | Additional information | Description |
|---|---|---|---|
| includeSupplierDetails | bool |
Default value is False |
Optional. If set to true the Supplier is included. |
| includeBankAccountDetails | bool |
Default value is False |
Optional. If set to true the Bank Account is included. |
Body Parameters
None.
Response Information
Resource Description
This collection is wrapped in a paging response object.
Paging response of Supplier Payment| Name | Type | Additional information | Description |
|---|---|---|---|
| TotalResults | integer |
None. |
|
| ReturnedResults | integer |
None. |
|
| Results | Collection of Supplier Payment |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalResults": 1,
"ReturnedResults": 2,
"Results": [
{
"ID": 1,
"SupplierId": 2,
"Date": "2024-11-15",
"Payee": "sample string 4",
"DocumentNumber": "sample string 5",
"Reference": "sample string 6",
"Description": "sample string 7",
"Comments": "sample string 8",
"Total": 9.0,
"Discount": 10.0,
"TotalUnallocated": 11.0,
"Reconciled": true,
"BankAccountId": 13,
"PaymentMethod": 1,
"Status": 0,
"TaxPeriodId": 1,
"Editable": true,
"Accepted": true,
"Locked": true,
"AnalysisCategoryId1": 1,
"AnalysisCategoryId2": 1,
"AnalysisCategoryId3": 1,
"Printed": true,
"BankUniqueIdentifier": "sample string 18",
"ImportTypeId": 1,
"BankImportMappingId": 1,
"BankAccount_CurrencyId": 1,
"BankAccount_ExchangeRate": 1.0,
"Supplier_CurrencyId": 1,
"Supplier_ExchangeRate": 1.0,
"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": "3c16ce5d-74ae-410d-9cd4-5d0058abb996",
"CompanyId": 9
},
"DueDateMethodId": 1,
"DueDateMethodValue": 1,
"SubjectToDRCVat": true,
"ID": 38
},
"BankAccount": {
"Name": "sample string 2",
"BankName": "sample string 3",
"AccountNumber": "sample string 4",
"BranchName": "sample string 5",
"BranchNumber": "sample string 6",
"Category": {
"Description": "sample string 1",
"ID": 2,
"Modified": "2024-11-15",
"Created": "2024-11-15"
},
"Active": true,
"Default": true,
"Balance": 9.0,
"Description": "sample string 10",
"BankFeedAccount": {
"ID": 1,
"BankFeedAccountGroupId": 2,
"BankFeedAccountGroup": {
"ID": 1,
"BankFeedProviderId": 2,
"BankFeedProviderTypeId": 3,
"Description": "sample string 4",
"Identifier": "sample string 5",
"RequiresAdditionalAuthentication": true,
"LastRefreshStatusId": 7
},
"Description": "sample string 3",
"Identifier": "sample string 4",
"LastRefreshDate": "2024-11-15",
"FirstImportDate": "2024-11-15",
"Balance": 1.0,
"BankAccountId": 1,
"BankAccountName": "sample string 5",
"LastRefreshStatusId": 6
},
"LastTransactionDate": "2024-11-15",
"LastImportDate": "2024-11-15",
"HasTransactionsWaitingForReview": true,
"HasActivity": true,
"DefaultPaymentMethodId": 1,
"PaymentMethod": 1,
"Modified": "2024-11-15",
"Created": "2024-11-15",
"CurrencyId": 1,
"ID": 13
},
"Modified": "2024-11-15",
"Created": "2024-11-15",
"UID": "53702a59-a86d-494a-9220-656f64d91dbb",
"$TrackingCode": "sample string 20"
},
{
"ID": 1,
"SupplierId": 2,
"Date": "2024-11-15",
"Payee": "sample string 4",
"DocumentNumber": "sample string 5",
"Reference": "sample string 6",
"Description": "sample string 7",
"Comments": "sample string 8",
"Total": 9.0,
"Discount": 10.0,
"TotalUnallocated": 11.0,
"Reconciled": true,
"BankAccountId": 13,
"PaymentMethod": 1,
"Status": 0,
"TaxPeriodId": 1,
"Editable": true,
"Accepted": true,
"Locked": true,
"AnalysisCategoryId1": 1,
"AnalysisCategoryId2": 1,
"AnalysisCategoryId3": 1,
"Printed": true,
"BankUniqueIdentifier": "sample string 18",
"ImportTypeId": 1,
"BankImportMappingId": 1,
"BankAccount_CurrencyId": 1,
"BankAccount_ExchangeRate": 1.0,
"Supplier_CurrencyId": 1,
"Supplier_ExchangeRate": 1.0,
"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": "3c16ce5d-74ae-410d-9cd4-5d0058abb996",
"CompanyId": 9
},
"DueDateMethodId": 1,
"DueDateMethodValue": 1,
"SubjectToDRCVat": true,
"ID": 38
},
"BankAccount": {
"Name": "sample string 2",
"BankName": "sample string 3",
"AccountNumber": "sample string 4",
"BranchName": "sample string 5",
"BranchNumber": "sample string 6",
"Category": {
"Description": "sample string 1",
"ID": 2,
"Modified": "2024-11-15",
"Created": "2024-11-15"
},
"Active": true,
"Default": true,
"Balance": 9.0,
"Description": "sample string 10",
"BankFeedAccount": {
"ID": 1,
"BankFeedAccountGroupId": 2,
"BankFeedAccountGroup": {
"ID": 1,
"BankFeedProviderId": 2,
"BankFeedProviderTypeId": 3,
"Description": "sample string 4",
"Identifier": "sample string 5",
"RequiresAdditionalAuthentication": true,
"LastRefreshStatusId": 7
},
"Description": "sample string 3",
"Identifier": "sample string 4",
"LastRefreshDate": "2024-11-15",
"FirstImportDate": "2024-11-15",
"Balance": 1.0,
"BankAccountId": 1,
"BankAccountName": "sample string 5",
"LastRefreshStatusId": 6
},
"LastTransactionDate": "2024-11-15",
"LastImportDate": "2024-11-15",
"HasTransactionsWaitingForReview": true,
"HasActivity": true,
"DefaultPaymentMethodId": 1,
"PaymentMethod": 1,
"Modified": "2024-11-15",
"Created": "2024-11-15",
"CurrencyId": 1,
"ID": 13
},
"Modified": "2024-11-15",
"Created": "2024-11-15",
"UID": "53702a59-a86d-494a-9220-656f64d91dbb",
"$TrackingCode": "sample string 20"
}
]
}