Issue cards

The Issue cards API is a background functionality of a web client at Profit365 > Inventory > Issue-Cards.

Content:

Resource information

Url https://api.profit365.eu/1.6/warehouses/issue-cards
Authentication required
Access level company
Response JSON / XML
Class Business entity

Create new issue card

Creating an issue card is a advanced process. Profit 365 has to keep accounting in case Warehouses are set to be accounted, system integrity and consistency of an issue card. On top of it, rows inserted are mastered to follow rules set by stock valuation method.

Url https://api.profit365.eu/1.6/warehouses/issue-cards
Method POST
Content A new issue card data
Example POST https://api.profit365.eu/1.6/warehouses/issue-cards

Authorization: Basic *** hidden credentials ***
ClientID: C7A36D...
ClientSecret: j7896WnI0U1...
CompanyID: CCA256B...
Content-Type: application/json

{
"ordnerID": "3dba6503-622e-4b71-9be4-d8fa92b3fc36",
"warehouseCode": "GOODS_05",
"partnerID": "978d7271-ff1d-4fd1-bc52-ff03aa9200e4",
"dateCreated": "2015-01-01",
"rows": [{ "itemCode": "ST4-01",
"name": "Sheets A4",
"quantity": 20
}, { "code": "PCL-07",
"name": "Pencil",
"sellPrice": 0.23,
"quantity": 200
}] }

Issue card data

ordnerId

required

ID of an ordner where is the issue card stored.

Type: GUID

 request, response

warehouseId

required

ID of a warehouse.

Type: GUID

 request, response

partnerId

required

Customer ID from a business partners list

Type: GUID

 request, response

rows

required

A collection of issue card's rows. The issue card may contain one or multiple rows. Each row represents exactly one issued item. See row data

Type: Array

 request, response

recordNumber

optional

A unique number of the issue card. When inserting empty, record number will be generated by the counter. When updating, empty record number wont be generated. Duplicate record number will be denied.

Type: String

 request, response

tags

optional

An Array of tags helps to search, group and link issue cards

Type: String Array

 request, response

partnerAddress

optional

Delivery address / info of a partner

Type: String

 request, response

dateCreated

optional

Date of issue card creation. When not sed, current date is used.

Type: DateTime

 request, response

dateAccounting

optional

An accounting date for the issue card. A period, when not set, is selected by dateAccounting.

Type: DateTime

 request, response

dateOperation

optional

A date, issue was performed.

Type: DateTime

 request, response

periodId

optional

A accounting period for the invoice. If not set, system will find period by dateAccounting.

Type: GUID

 request, response

itemsComment

optional

A comment above items.

Type: string

 request, response

reportId

optional

ID of report used as default during the print.

Type: GUID

 request, response

Issue card row data

itemId

required

ID of an item from price list.

Type: GUID

 request, response

code

optional

A free text field. If not set, will be automatically filled form item.

Type: string

 request, response

name

optional

A free text field. If not set, will be automatically filled form item.

Type: string

 request, response

unitId

optional

ID of an unit, quantity is measured by. If not set, will be automatically filled form item.

Type: GUID

 request, response

lotNumberID

optional

ID of Item's LotNumber. REQUIRED if Item has LotNumbers.

Type: GUID

 request, response

quantity

optional

A quantity of an issued item. If not sent, 1 is used.

Type: Number

 request, response

sellPrice

required

Selling price of Item per unit. If not set, will be automatically filled form item.

Type: Number

 request, response

costPrice

required

Cost price per unit. Cost price is by default calculated using stock valuation method. Manual set is allowed only on update, or using Custom valuation method.

Type: Number

 request, response

 

New issue card data

A new issue card data extends a standard issue card data with custom properties. A new issue card data are available only in case when inserting new issue-card.

ordnerCode

optional

Code of an ordner where is the issue card stored, alternative to ordnerID. 

Type: String

 request

warehouseCode

optional

Code of a warehouse, alternative to warehouseID.

Type: String

 request

reportCode

optional

Code of default report used for print of this record, alternative to reportID

Type: String

 request

New issue card row data

itemCode

optional

Code of an item, alternative to itemID.

Type: String

 request

unitCode

optional

Code of a unit, alternative to unitID.

Type: String

 request

Copy into issue card

Issue card can be copied/generated from another document. New issue card can be generated and automatically saved using POST method, so returned object is reflection of the new issue card record stored in database with valid IDs, or pregenerated like preview using GET method without storing in database and generating IDs allowing further editation and classic insert of issue card.

As source may serve another issue card (copy), receipt card or invoice.

Source record's rows are merged by itemId, lotNumberId and costPrice, then issued using actual stock valuation method. When negative stock amount is allowed, cost price of those pieces is set to 0. If not allowed and more than available amount is requested, OperationCanceledException will occur. Items avaibility is checked up to dateOperation, so defining correct parameter value may be crucial.

Url https://api.profit365.eu/1.6/warehouse/issue-cards/copy
Method GET, POST
Example POST https://api.profit365.eu/1.6/warehouses/issue-cards/copy?sourceId=A78FD5...&dateOperation=2016-01-01

ClientID: C7A36D...
ClientSecret: j7896WnI0U1...
Authorization: Basic *** hidden credentials ***
CompanyID: CCA256B...

sourceId

required

ID of record used as source for new issue card.

Type: GUID

 request URL

dateOperation

optional

An issuing date used for new record. Today by default.

Type: DateTime

 request URL
  • Pubished at 8/5/2016 12:37:10 PM
  • Last edited 10/19/2018 11:37:31 AM

Back to top ↑