API CreatePayment: Porovnání verzí
Z Podpora.nextis.cz
(Založena nová stránka s textem „API CreatePayment“) |
|||
| (Nejsou zobrazeny 2 mezilehlé verze od stejného uživatele.) | |||
| Řádka 1: | Řádka 1: | ||
| − | + | ==== Description ==== | |
| + | Method allows You to create new payment in system. | ||
| + | |||
| + | ==== Exact name ==== | ||
| + | <code>API_CreatePayment</code> | ||
| + | |||
| + | ==== Type ==== | ||
| + | Standard executable stored procedure. | ||
| + | |||
| + | ==== Specification ==== | ||
| + | {| class="wikitable" | ||
| + | !Parameter | ||
| + | !Data type | ||
| + | !Value range | ||
| + | !Description | ||
| + | !Relation | ||
| + | |- | ||
| + | |@DocumentID | ||
| + | |int | ||
| + | | | ||
| + | |ID of invoices from invoices list (see relation) | ||
| + | |API_GetInvoices.ID | ||
| + | |- | ||
| + | |@CurrencyID | ||
| + | |int | ||
| + | | | ||
| + | |ID of currency from currency list (see relation) | ||
| + | |API_GetCurrency.ID | ||
| + | |- | ||
| + | |@CurrencyIDInCurrency | ||
| + | |int | ||
| + | | | ||
| + | |ID of currency from currency list (see relation) | ||
| + | |API_GetCurrency.ID | ||
| + | |- | ||
| + | |@ExchangeRate | ||
| + | |decimal(18,6) | ||
| + | | | ||
| + | |Exchange rate | ||
| + | | | ||
| + | |- | ||
| + | |@Price | ||
| + | |decimal(19,4) | ||
| + | | | ||
| + | |Price | ||
| + | | | ||
| + | |- | ||
| + | |@PriceInCurrency | ||
| + | |decimal(18,4) | ||
| + | | | ||
| + | |Price in currency | ||
| + | | | ||
| + | |- | ||
| + | |@Note | ||
| + | |nvarchar(150) | ||
| + | | | ||
| + | |Note | ||
| + | | | ||
| + | |- | ||
| + | |@Purpose | ||
| + | |nvarchar(150) | ||
| + | | | ||
| + | |Purpose | ||
| + | | | ||
| + | |} | ||
| + | |||
| + | ==== Return ==== | ||
| + | 0 : OK | ||
| + | 100 : Item could not be created | ||
| + | |||
| + | ==== Example ==== | ||
| + | <syntaxhighlight lang="sql"> | ||
| + | DECLARE @return_value int | ||
| + | EXEC @return_value = [API_CreatePayment] @DocumentID = 1, @CurrencyID = 144, @CurrencyIDInCurrency = 15907, @ExchangeRate = 0.0394, @Price = 19238.578680, @PriceInCurrency = 758.000000, @Note = 'Note', @Purpose = 'Purpose' | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | ==== Notices ==== | ||
| + | None. | ||
Aktuální verze z 9. 11. 2018, 15:23
Description
Method allows You to create new payment in system.
Exact name
API_CreatePayment
Type
Standard executable stored procedure.
Specification
| Parameter | Data type | Value range | Description | Relation |
|---|---|---|---|---|
| @DocumentID | int | ID of invoices from invoices list (see relation) | API_GetInvoices.ID | |
| @CurrencyID | int | ID of currency from currency list (see relation) | API_GetCurrency.ID | |
| @CurrencyIDInCurrency | int | ID of currency from currency list (see relation) | API_GetCurrency.ID | |
| @ExchangeRate | decimal(18,6) | Exchange rate | ||
| @Price | decimal(19,4) | Price | ||
| @PriceInCurrency | decimal(18,4) | Price in currency | ||
| @Note | nvarchar(150) | Note | ||
| @Purpose | nvarchar(150) | Purpose |
Return
0 : OK 100 : Item could not be created
Example
DECLARE @return_value int
EXEC @return_value = [API_CreatePayment] @DocumentID = 1, @CurrencyID = 144, @CurrencyIDInCurrency = 15907, @ExchangeRate = 0.0394, @Price = 19238.578680, @PriceInCurrency = 758.000000, @Note = 'Note', @Purpose = 'Purpose'
Notices
None.
