POST SupplierPayment/Save?useSystemDocumentNumber={useSystemDocumentNumber}

Saves the specified Supplier Payment.

Request Information

URI Parameters

NameTypeAdditional informationDescription
useSystemDocumentNumber bool

Default value is True

Use system Document Number or Document Number provided.

Body Parameters

The Supplier Payment.

Supplier Payment
NameTypeAdditional informationDescription
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": "2021-10-19",
  "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": "2021-10-19",
      "Created": "2021-10-19"
    },
    "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": "2021-10-19",
    "DateField2": "2021-10-19",
    "DateField3": "2021-10-19",
    "HasSpecialCountryTax": true,
    "AccountingAgreement": true,
    "HasSpecialCountryTaxActivity": true,
    "Modified": "2021-10-19",
    "Created": "2021-10-19",
    "BusinessRegistrationNumber": "sample string 33",
    "RMCDApprovalNumber": "sample string 34",
    "TaxStatusVerified": "2021-10-19",
    "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": "2021-10-19",
      "Modified": "2021-10-19",
      "TaxTypeDefaultUID": "d648ff6e-d446-4219-8e61-ad3079b5caba",
      "CompanyId": 9
    },
    "DueDateMethodId": 1,
    "DueDateMethodValue": 1,
    "ID": 37
  },
  "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": "2021-10-19",
      "Created": "2021-10-19"
    },
    "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": "2021-10-19",
      "FirstImportDate": "2021-10-19",
      "Balance": 1.0,
      "BankAccountId": 1,
      "BankAccountName": "sample string 5",
      "LastRefreshStatusId": 6
    },
    "LastTransactionDate": "2021-10-19",
    "LastImportDate": "2021-10-19",
    "HasTransactionsWaitingForReview": true,
    "HasActivity": true,
    "DefaultPaymentMethodId": 1,
    "PaymentMethod": 1,
    "Modified": "2021-10-19",
    "Created": "2021-10-19",
    "CurrencyId": 1,
    "ID": 13
  },
  "Modified": "2021-10-19",
  "Created": "2021-10-19",
  "UID": "fce992e7-a0d6-4dff-ab2a-ffad7b94aee6"
}

Response Information

Resource Description

Supplier Payment
NameTypeAdditional informationDescription
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": "2021-10-19",
  "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": "2021-10-19",
      "Created": "2021-10-19"
    },
    "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": "2021-10-19",
    "DateField2": "2021-10-19",
    "DateField3": "2021-10-19",
    "HasSpecialCountryTax": true,
    "AccountingAgreement": true,
    "HasSpecialCountryTaxActivity": true,
    "Modified": "2021-10-19",
    "Created": "2021-10-19",
    "BusinessRegistrationNumber": "sample string 33",
    "RMCDApprovalNumber": "sample string 34",
    "TaxStatusVerified": "2021-10-19",
    "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": "2021-10-19",
      "Modified": "2021-10-19",
      "TaxTypeDefaultUID": "c7235040-6d41-4216-a3a4-8cdcae09a577",
      "CompanyId": 9
    },
    "DueDateMethodId": 1,
    "DueDateMethodValue": 1,
    "ID": 37
  },
  "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": "2021-10-19",
      "Created": "2021-10-19"
    },
    "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": "2021-10-19",
      "FirstImportDate": "2021-10-19",
      "Balance": 1.0,
      "BankAccountId": 1,
      "BankAccountName": "sample string 5",
      "LastRefreshStatusId": 6
    },
    "LastTransactionDate": "2021-10-19",
    "LastImportDate": "2021-10-19",
    "HasTransactionsWaitingForReview": true,
    "HasActivity": true,
    "DefaultPaymentMethodId": 1,
    "PaymentMethod": 1,
    "Modified": "2021-10-19",
    "Created": "2021-10-19",
    "CurrencyId": 1,
    "ID": 13
  },
  "Modified": "2021-10-19",
  "Created": "2021-10-19",
  "UID": "25e18f71-55ed-4fd5-a1ac-2a4ffe24fad7"
}