POST SupplierInvoice/Calculate

Calculates the specified Supplier Invoice.

Request Information

URI Parameters

None.

Body Parameters

The Supplier Invoice.

Supplier Invoice
NameTypeAdditional informationDescription
ID integer

None.

Date date

Required

Inclusive bool

None.

DiscountPercentage decimal

None.

TaxReference string

String length: inclusive between 0 and 30

DocumentNumber string

String length: inclusive between 0 and 100

Reference string

String length: inclusive between 0 and 100

Message string

String length: inclusive between 0 and 8000

Discount decimal

None.

Exclusive decimal

None.

Tax decimal

None.

Rounding decimal

None.

Total decimal

None.

AmountDue decimal

Data type: Currency

PostalAddress01 string

String length: inclusive between 0 and 100

PostalAddress02 string

String length: inclusive between 0 and 100

PostalAddress03 string

String length: inclusive between 0 and 100

PostalAddress04 string

String length: inclusive between 0 and 100

PostalAddress05 string

String length: inclusive between 0 and 100

DeliveryAddress01 string

String length: inclusive between 0 and 100

DeliveryAddress02 string

String length: inclusive between 0 and 100

DeliveryAddress03 string

String length: inclusive between 0 and 100

DeliveryAddress04 string

String length: inclusive between 0 and 100

DeliveryAddress05 string

String length: inclusive between 0 and 100

TaxPeriodId nullable integer

Read Only / System Generated

Editable bool

Read Only / System Generated

HasAttachments bool

Read Only / System Generated

HasNotes nullable bool

Read Only / System Generated

HasAnticipatedDate nullable bool

Read Only / System Generated

AnticipatedDate nullable date

Read Only / System Generated

ExternalReference string

String length: inclusive between 0 and 100

UID globally unique identifier

Read Only / System Generated

SupplierId integer

Required

SupplierName string

None.

Supplier Supplier

None.

Modified nullable date

Read Only / System Generated

Created date

Read Only / System Generated

StatusId nullable integer

None.

Supplier_CurrencyId nullable integer

None.

Supplier_ExchangeRate nullable decimal

None.

DueDate date

Required

Paid nullable bool

Read Only / System Generated

This field is not editable.

Status string

Read Only / System Generated

FromDocument string

None.

Locked bool

Read Only / System Generated

HasAdditionalCost bool

Read Only / System Generated

Lines Collection of Commercial Document Line

None.

Request Formats

application/json, text/json

Sample:
{
  "DueDate": "2021-10-16",
  "Paid": true,
  "Status": "sample string 1",
  "FromDocument": "sample string 2",
  "Locked": true,
  "HasAdditionalCost": true,
  "SupplierId": 5,
  "SupplierName": "sample string 6",
  "Supplier": {
    "Name": "sample string 1",
    "Category": {
      "Description": "sample string 1",
      "ID": 2,
      "Modified": "2021-10-16",
      "Created": "2021-10-16"
    },
    "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-16",
    "DateField2": "2021-10-16",
    "DateField3": "2021-10-16",
    "HasSpecialCountryTax": true,
    "AccountingAgreement": true,
    "HasSpecialCountryTaxActivity": true,
    "Modified": "2021-10-16",
    "Created": "2021-10-16",
    "BusinessRegistrationNumber": "sample string 33",
    "RMCDApprovalNumber": "sample string 34",
    "TaxStatusVerified": "2021-10-16",
    "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-16",
      "Modified": "2021-10-16",
      "TaxTypeDefaultUID": "ba804edc-b62e-4746-9499-44459a57dac9",
      "CompanyId": 9
    },
    "DueDateMethodId": 1,
    "DueDateMethodValue": 1,
    "ID": 37
  },
  "Modified": "2021-10-16",
  "Created": "2021-10-16",
  "StatusId": 1,
  "Supplier_CurrencyId": 1,
  "Supplier_ExchangeRate": 1.0,
  "ID": 8,
  "Date": "2021-10-16",
  "Inclusive": true,
  "DiscountPercentage": 10.1,
  "TaxReference": "sample string 11",
  "DocumentNumber": "sample string 12",
  "Reference": "sample string 13",
  "Message": "sample string 14",
  "Discount": 15.0,
  "Exclusive": 16.0,
  "Tax": 17.0,
  "Rounding": 18.0,
  "Total": 19.0,
  "AmountDue": 20.0,
  "PostalAddress01": "sample string 21",
  "PostalAddress02": "sample string 22",
  "PostalAddress03": "sample string 23",
  "PostalAddress04": "sample string 24",
  "PostalAddress05": "sample string 25",
  "DeliveryAddress01": "sample string 26",
  "DeliveryAddress02": "sample string 27",
  "DeliveryAddress03": "sample string 28",
  "DeliveryAddress04": "sample string 29",
  "DeliveryAddress05": "sample string 30",
  "Printed": true,
  "TaxPeriodId": 1,
  "Editable": true,
  "HasAttachments": true,
  "HasNotes": true,
  "HasAnticipatedDate": true,
  "AnticipatedDate": "2021-10-16",
  "ExternalReference": "sample string 34",
  "UID": "12c8ece5-6c70-405e-9379-36945141123b",
  "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": "aefa4fef-9a5f-4a26-af75-7cc977790b0b"
    },
    {
      "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": "aefa4fef-9a5f-4a26-af75-7cc977790b0b"
    }
  ]
}

Response Information

Resource Description

Supplier Invoice
NameTypeAdditional informationDescription
ID integer

None.

Date date

Required

Inclusive bool

None.

DiscountPercentage decimal

None.

TaxReference string

String length: inclusive between 0 and 30

DocumentNumber string

String length: inclusive between 0 and 100

Reference string

String length: inclusive between 0 and 100

Message string

String length: inclusive between 0 and 8000

Discount decimal

None.

Exclusive decimal

None.

Tax decimal

None.

Rounding decimal

None.

Total decimal

None.

AmountDue decimal

Data type: Currency

PostalAddress01 string

String length: inclusive between 0 and 100

PostalAddress02 string

String length: inclusive between 0 and 100

PostalAddress03 string

String length: inclusive between 0 and 100

PostalAddress04 string

String length: inclusive between 0 and 100

PostalAddress05 string

String length: inclusive between 0 and 100

DeliveryAddress01 string

String length: inclusive between 0 and 100

DeliveryAddress02 string

String length: inclusive between 0 and 100

DeliveryAddress03 string

String length: inclusive between 0 and 100

DeliveryAddress04 string

String length: inclusive between 0 and 100

DeliveryAddress05 string

String length: inclusive between 0 and 100

TaxPeriodId nullable integer

Read Only / System Generated

Editable bool

Read Only / System Generated

HasAttachments bool

Read Only / System Generated

HasNotes nullable bool

Read Only / System Generated

HasAnticipatedDate nullable bool

Read Only / System Generated

AnticipatedDate nullable date

Read Only / System Generated

ExternalReference string

String length: inclusive between 0 and 100

UID globally unique identifier

Read Only / System Generated

SupplierId integer

Required

SupplierName string

None.

Supplier Supplier

None.

Modified nullable date

Read Only / System Generated

Created date

Read Only / System Generated

StatusId nullable integer

None.

Supplier_CurrencyId nullable integer

None.

Supplier_ExchangeRate nullable decimal

None.

DueDate date

Required

Paid nullable bool

Read Only / System Generated

This field is not editable.

Status string

Read Only / System Generated

FromDocument string

None.

Locked bool

Read Only / System Generated

HasAdditionalCost bool

Read Only / System Generated

Lines Collection of Commercial Document Line

None.

Response Formats

application/json, text/json

Sample:
{
  "DueDate": "2021-10-16",
  "Paid": true,
  "Status": "sample string 1",
  "FromDocument": "sample string 2",
  "Locked": true,
  "HasAdditionalCost": true,
  "SupplierId": 5,
  "SupplierName": "sample string 6",
  "Supplier": {
    "Name": "sample string 1",
    "Category": {
      "Description": "sample string 1",
      "ID": 2,
      "Modified": "2021-10-16",
      "Created": "2021-10-16"
    },
    "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-16",
    "DateField2": "2021-10-16",
    "DateField3": "2021-10-16",
    "HasSpecialCountryTax": true,
    "AccountingAgreement": true,
    "HasSpecialCountryTaxActivity": true,
    "Modified": "2021-10-16",
    "Created": "2021-10-16",
    "BusinessRegistrationNumber": "sample string 33",
    "RMCDApprovalNumber": "sample string 34",
    "TaxStatusVerified": "2021-10-16",
    "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-16",
      "Modified": "2021-10-16",
      "TaxTypeDefaultUID": "8a09895b-9af6-4b77-80f9-ae670d6455ec",
      "CompanyId": 9
    },
    "DueDateMethodId": 1,
    "DueDateMethodValue": 1,
    "ID": 37
  },
  "Modified": "2021-10-16",
  "Created": "2021-10-16",
  "StatusId": 1,
  "Supplier_CurrencyId": 1,
  "Supplier_ExchangeRate": 1.0,
  "ID": 8,
  "Date": "2021-10-16",
  "Inclusive": true,
  "DiscountPercentage": 10.1,
  "TaxReference": "sample string 11",
  "DocumentNumber": "sample string 12",
  "Reference": "sample string 13",
  "Message": "sample string 14",
  "Discount": 15.0,
  "Exclusive": 16.0,
  "Tax": 17.0,
  "Rounding": 18.0,
  "Total": 19.0,
  "AmountDue": 20.0,
  "PostalAddress01": "sample string 21",
  "PostalAddress02": "sample string 22",
  "PostalAddress03": "sample string 23",
  "PostalAddress04": "sample string 24",
  "PostalAddress05": "sample string 25",
  "DeliveryAddress01": "sample string 26",
  "DeliveryAddress02": "sample string 27",
  "DeliveryAddress03": "sample string 28",
  "DeliveryAddress04": "sample string 29",
  "DeliveryAddress05": "sample string 30",
  "Printed": true,
  "TaxPeriodId": 1,
  "Editable": true,
  "HasAttachments": true,
  "HasNotes": true,
  "HasAnticipatedDate": true,
  "AnticipatedDate": "2021-10-16",
  "ExternalReference": "sample string 34",
  "UID": "3453c83d-997f-4c42-9563-b771256fefed",
  "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": "251928fa-9b03-4725-9f3a-f4a28d2fb395"
    },
    {
      "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": "251928fa-9b03-4725-9f3a-f4a28d2fb395"
    }
  ]
}