POST SupplierPayment/Save?useSystemDocumentNumber={useSystemDocumentNumber}

Saves the specified Supplier Payment.

Request Information

URI Parameters

Name	Type	Additional information	Description
useSystemDocumentNumber	bool	Default value is True	Use system Document Number or Document Number provided.

Body Parameters

The Supplier Payment.

Supplier Payment

Name	Type	Additional information	Description
ID	integer	None.
SupplierId	integer	None.
Date	date	None.
Payee	string	String length: inclusive between 0 and 8000
DocumentNumber	string	String length: inclusive between 0 and 100
Reference	string	String length: inclusive between 0 and 100
Description	string	String length: inclusive between 0 and 100
Comments	string	String length: inclusive between 0 and 8000
Total	decimal	None.
Discount	decimal	None.
TotalUnallocated	decimal	None.
Reconciled	bool	None.
BankAccountId	integer	None.
PaymentMethod	Payment Method	None.
Status	Supplier Payment Status	None.
TaxPeriodId	nullable integer	Read Only / System Generated
Editable	bool	Read Only / System Generated
Accepted	bool	None.
Locked	bool	Read Only / System Generated
AnalysisCategoryId1	nullable integer	None.	Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.
AnalysisCategoryId2	nullable integer	None.	Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.
AnalysisCategoryId3	nullable integer	None.	Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.
Printed	bool	Read Only / System Generated
BankUniqueIdentifier	string	None.
ImportTypeId	nullable integer	None.
BankImportMappingId	nullable integer	None.
BankAccount_CurrencyId	nullable integer	None.
BankAccount_ExchangeRate	nullable decimal	None.
Supplier_CurrencyId	nullable integer	None.
Supplier_ExchangeRate	nullable decimal	None.
Supplier	Supplier	None.
BankAccount	Bank Account	Read Only / System Generated
Modified	nullable date	Read Only / System Generated
Created	date	Read Only / System Generated
UID	globally unique identifier	Read Only / System Generated

Request Formats

application/json, text/json

Sample:

{
  "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": "e77a03a2-6879-4d0b-8deb-70cc3a09c0ec",
      "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": "6aea3233-eef1-4201-bdea-bb4e92df3776",
  "$TrackingCode": "sample string 20"
}

Response Information

Resource Description

Supplier Payment

Name	Type	Additional information	Description
ID	integer	None.
SupplierId	integer	None.
Date	date	None.
Payee	string	String length: inclusive between 0 and 8000
DocumentNumber	string	String length: inclusive between 0 and 100
Reference	string	String length: inclusive between 0 and 100
Description	string	String length: inclusive between 0 and 100
Comments	string	String length: inclusive between 0 and 8000
Total	decimal	None.
Discount	decimal	None.
TotalUnallocated	decimal	None.
Reconciled	bool	None.
BankAccountId	integer	None.
PaymentMethod	Payment Method	None.
Status	Supplier Payment Status	None.
TaxPeriodId	nullable integer	Read Only / System Generated
Editable	bool	Read Only / System Generated
Accepted	bool	None.
Locked	bool	Read Only / System Generated
AnalysisCategoryId1	nullable integer	None.	Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.
AnalysisCategoryId2	nullable integer	None.	Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.
AnalysisCategoryId3	nullable integer	None.	Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId.
Printed	bool	Read Only / System Generated
BankUniqueIdentifier	string	None.
ImportTypeId	nullable integer	None.
BankImportMappingId	nullable integer	None.
BankAccount_CurrencyId	nullable integer	None.
BankAccount_ExchangeRate	nullable decimal	None.
Supplier_CurrencyId	nullable integer	None.
Supplier_ExchangeRate	nullable decimal	None.
Supplier	Supplier	None.
BankAccount	Bank Account	Read Only / System Generated
Modified	nullable date	Read Only / System Generated
Created	date	Read Only / System Generated
UID	globally unique identifier	Read Only / System Generated

Response Formats

application/json, text/json

Sample:

{
  "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": "94f3ee93-28b4-4818-8736-264a3dbdf674",
      "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": "b58c4643-f7bf-4b55-aed2-68018009e505",
  "$TrackingCode": "sample string 20"
}