Get a range with purchase receipts, ScreenId=PO302000Please use a page size lower or equal to the allowed max page size which is 500
Catalog: VismaNet
Schema: PurchaseReceiptBasic
The data in this table is partitioned per value of the COMPANY_CODE column.
Retrieve: true
Insert: true
Update: true
Delete: false
Select Visma.net API URL: /controller/api/v1/PurchaseReceiptBasic
Insert Visma.net API URL: /controller/api/v1/PurchaseReceiptBasic
Update Visma.net API URL: /controller/api/v1/PurchaseReceiptBasic
Delete Visma.net API URL: /controller/api/v1/PurchaseReceiptBasic
Field Selection Method: NotRequired
Select Visma.net API Operation: get /controller/api/v1/PurchaseReceiptBasic
Insert Visma.net API Operation: post /controller/api/v1/PurchaseReceiptBasic
Update Visma.net API Operation: put /controller/api/v1/PurchaseReceiptBasic/{poReceiptNumber}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function PurchaseReceiptsBasic. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
COMPANY_CODE |
string |
☐ |
|
Partition to retrieve data from. |
greaterThanValue |
string |
☐ |
|
|
lastModifiedDateTime |
string |
☐ |
|
|
lastModifiedDateTimeCondition |
string |
☐ |
|
|
numberToRead |
int32 |
☐ |
|
This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords. |
pageNumber |
int32 |
☐ |
|
Pagination parameter. Page number. |
pageSize |
int32 |
☐ |
|
Pagination parameter. Number of items to be collected. |
poOrderNbr |
string |
☐ |
|
|
receiptType |
string |
☐ |
|
Values: PoReceipt, PoReturn, TransferReceipt. |
skipRecords |
int32 |
☐ |
|
This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords. |
status |
string |
☐ |
|
Values: Hold, Balanced, Released. |
supplier |
string |
☐ |
|
|
Table Function Columns
The columns of the table function PurchaseReceiptsBasic are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert or update.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
branchNumber_name |
string |
Branch Name |
☐ |
Click the magnifier. > The name. |
branchNumber_number |
string |
Branch Number |
☐ |
Click the magnifier. > The identifier. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
controlQty |
double |
|
☐ |
The top part > Control qty. > The total quantity of goods on the receipt or return |
controlTotal |
double |
Total for Control |
☐ |
The top part > Control amt. > The total amount of the receipt or return, which you manually enter. |
createBill |
boolean |
Create Bill |
☐ |
The top part > Create invoice > A check box that you select if the system must create an appropriate invoice (or adjustment) automatically when the purchase receipt is released. |
currency |
string |
Currency |
☐ |
The top part > Currency > The currency the supplier uses for invoicing. |
date |
datetime |
Date |
☐ |
Mandatory field: The top part > Date* > The date when the receipt document was created. |
errorInfo |
string |
Error Message |
☐ |
|
exchangeRate |
double |
Exchange Rate |
☐ |
|
hold |
boolean |
Hold |
☐ |
The top part > Hold > A check box that indicates (if selected) that the document has the On hold status. |
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
System generated information. |
location_countryId |
string |
Location Country ID |
☐ |
Location*. |
location_id |
string |
Location ID |
☐ |
Click the magnifier > The identifier |
location_name |
string |
Location Name |
☐ |
Click the magnifier > The displayed name |
metadata_maxPageSize |
int64 |
|
☐ |
|
metadata_totalCount |
int64 |
Total Count |
☐ |
|
postPeriod |
string |
Post Period |
☐ |
Mandatory field: The top part > Post period* > The financial period to which the transactions recorded in the document should be posted. Format MMYYYY. |
receiptNbr |
string |
Receipt Number |
☐ |
The top part > Receipt no. > The unique reference number of the purchase receipt. |
receiptType |
string |
Receipt Type |
☐ |
The top part > Type > The type of the document, which can be one of the following options: Receipt, Return, Transfer receipt. |
status |
string |
Status |
☐ |
The top part > Status > The current status of the purchase or transfer receipt, or return, which the system assigns automatically. On hold, Balanced, Released. |
supplier_internalId |
int32 |
Supplier Internal ID |
☐ |
|
supplier_name |
string |
Supplier Name |
☐ |
The name of the particular destination of the selected type. |
supplier_number |
string |
Supplier Number |
☐ |
The identifier of the particular destination of the selected type. |
supplierRef |
string |
Supplier Reference |
☐ |
The top part > Supplier ref. > The reference number of the supplier document this receipt or return is based on. |
totalAmt |
double |
|
☐ |
The top part > Total amt. > The total amount calculated for items received from or returned to the supplier. |
totalQty |
double |
|
☐ |
The top part > Total qty. > The total quantity of items received from or returned to the supplier. |
vatExemptTotal |
double |
VAT Exempt Total |
☐ |
The top part > VAT exempt total > The document total that is exempt from VAT. |
vatTaxableTotal |
double |
VAT Taxable Total |
☐ |
The top part > VAT taxable total > The document total that is subjected to VAT. |
warehouse_description |
string |
Warehouse Description |
☐ |
Click on the magnifier. > The description. |
warehouse_id |
string |
Warehouse ID |
☐ |
Click on the magnifier. > The identifier. |
12-12-2020 18:42 Version 20.1.301-BETA+3023
