Search

savePurchaseDocument

Create a new purchase invoice, purchase order or purchase return, or update an existing one.

Input parameters

Parameter nameDescriptionPossible valueRequired
idID of existing document. If this parameter is present, then an existing document is updated.Integer
warehouseIDID of the warehouse
If omitted, system will associate with the warehouse with the first ID.
Integer
currencyCodeCurrency code: EUR, USD. Currency must be present in the system.String yes
noNumber to be given to the purchase document.String yes
typeIf your account has configuration setting use_purchase_waybills enabled, then the possible types are:
PRCORDERPurchase order
PRCINVOICEPurchase invoice-waybill. Takes items into stock and affects your Accounts Payable.

A Purchase Invoice-Waybill is equivalent to making a Purchase Waybill (PRCWAYBILL), followed by a Purchase Invoice (PRCINVOICEONLY)
CASHPRCINVOICEPurchase receipt. Same as previous.
PRCRETURNPurchase return. Functionally same as a purchase invoice-waybill, but it is used to return goods back to supplier.

On a purchase return, amounts are negative.
PRCWAYBILLPurchase waybill. This document ONLY takes items into stock, and does not generate an obligation to pay.
PRCINVOICEONLYPurchase invoice. This is usually a follow-up for the items that have arrived earlier with an invoice-waybill.

For example, the supplier may send shipments continuously throughout the month, and bill the customer once a month, for all the shipments sent.

The invoice does not affect stock, but it affects your Accounts Payable.


If the setting is not enabled, possible types are:
PRCORDERPurchase order
PRCINVOICEPurchase invoice-waybill. Takes items into stock and affects your Accounts Payable. (Here, we can also call it a "purchase invoice" for short, since there are no other similar document types.)
CASHPRCINVOICEPurchase receipt. Same as previous.
PRCRETURNPurchase return. Functionally same as a purchase invoice-waybill, but it is used to return goods back to supplier.


By default: PRCINVOICE
String
dateeg. 2010-01-29
If omitted, date of request will be used
Date
timeeg. 14:59:00
If omitted, time of submission will be used
Time
confirmInvoiceBy default 10 or 1
supplierIDInteger yes
addressIDInteger
contactIDInteger
employeeIDID of the system employee, who is set as the creator of the invoice/order/etc.Integer
stateIDStatus of the document itself. See getPurchaseDocumentStatuses.Integer
currencyRateeg. 1.25543
Exchange rate of the main currency against system's default currency.
If the invoice is in system's default currency, does not have to be specified (but if specified, use 1.0)
If omitted, the current exchange rate stored in the system will be used.
Decimal
paymentDayseg. 5
In how many days the purchase document is due.
Integer
paid0 or 1
referenceNumberString (50)
baseDocumentIDsSource document IDs, separated by commas, such as: 1,2,3,4,5String
notesString
shipDateISO date (yyyy-mm-dd)
netTotalForAccountingDecimal, 2 places
totalForAccountingDecimal, 2 places
*************

Lines (rows) of the purchase document. Send the lines as a flat list, each line defined by the following set of parameters. Replace # with set number (1, 2, 3, ...). For example: productID1, amount1, price1, vatrateID1 for the first invoice row, productID2, amount2, price2, vatrateID2 for the second one and so on.

VAT is calculated automatically, a separate VAT row is not needed. When updating an existing document and the input parameters contain no information about invoice rows, then sytem leaves the existing rows in the database as they are. However, if row definitions are present, then all rows on the document are replaced with new ones.

productID#ID of the product. Either productID or serviceID can be set, but not both at the same time. Both can be omitted, however - in that case a free-text invoice row is createdInteger
serviceID#ID of the serviceInteger
itemName#name of the item (use only if you want to override the default product/service name)String
vatrateID#ID of VAT rate.Integer yes
amount#

Purchased quantity.

On a Purchase Return, the quantity should be negative.

Decimal yes
price#Original net price (pre-discount) per item.Decimal yes
discount#Decimal
packageID#

Set this field if you want to indicate that the product is purchased as packages, or that you want to order the product in packages. Use it together with "amountOfPackages#".

Packages are product-specific; a product can have zero or more defined packages. To retrieve a product's packages, call getProducts with input parameter getPackageInfo = 1 and see the block productPackages in the output.

Integer
amountOfPackages#

Amount of packages sold.

If you specify both amount# and amountOfPackages#, they must correspond to each other: amount# must be equal to amountOfPackages# multiplied by the quantity in one package.

However, it is sufficient to specify only one of the two fields; the second one will be calculated automatically.

Decimal

Response

Field nameTypeDescription
invoiceIDIntegerID of the created (or updated) document
invoiceRegNoStringReg. number of the document (if it was confirmed)
invoiceNoString
invoiceLinkStringURL pointing to a HTML version of the document.

This URL is valid only for 24 hours; if you want to send the purchase invoice / PO by e-mail, you must retrieve the contents of this URL and enclose it as an attachment, instead of sending the URL itself.
netDecimalNet total of the document
vatDecimalTotal VAT of the document
totalDecimalDocument total