Insert/Update services

Deprecated

POST

/api

Last modified:2024-08-14 15:33:36

To insert/update one or more services, the web service endpoint is the same for the sales insertion/update, with the difference that these fields must also be present in the costs section of each goodsRecords array entry:

costs array structure

"costs": [{
    "rowNumber": 1,
    "itemCode": "",
    "listPrice": 100.00,
    "salePrice": "same as listPrice",
    "listPriceCompany": 100.00,
    "listPriceSite": 100.00,
    "discountValueSite": 33.00,
    "convertionRateCompany": 1.00,
    "convertionRateSite": 1.00,
    "taxRate": 0.22
}, { ... }, { ... }]

Refer to the Insert/Update Sales for any other information about the request

Notes

There's a limit of 100 calls for this API.

Request

Query Params

Header Params

Body Params application/json

Example

{
  "goodsRecords": [
    {
      "goods": {
        "entityCode": 6,
        "documentDate": "2016-04-12 00:00:00",
        "refDocument": 100,
        "causal": "SALE",
        "year": "2016",
        "movementDate": "2016-04-12 00:00:00",
        "currency": "EUR",
        "totalAmount": 666.00,
        "totalAmountCompany": 666.00,
        "totalAmountSite": 666.00,
        "convertionRateCompany": 1.00,
        "convertionRateSite": 1.00,
        "taxFreeNumber": null,
        "system": "ECOMMERCE",
        "startDate": null,
        "endDate": null,
        "customerCode": "12345",
        "card": null,
        "cardBarcode": null,
        "actionType": "PURCHASE",
        "actionStatus": "A",
        "result": "INTERFACE",
        "description": "insertSale"
      },
      "costs": [
        {
          "rowNumber": 1,
          "itemCode": "",
          "listPrice": 100.00,
          "salePrice": "impostarlo uguale a listPrice",
          "listPriceCompany": 100.00,
          "listPriceSite": 100.00,
          "discountValueSite": 33.00,
          "convertionRateCompany": 1.00,
          "convertionRateSite": 1.00,
          "taxRate": 0.22
        }
      ],
      "payments": [
        {
          "paymentType": "Credit",
          "paymentValue": 600.00
        }
      ]
    }
  ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api?cmd=insertServices_v3&appId=KEEPIT&applicationId=KEEPIT' \
--header 'username: {{USERNAME}}' \
--header 'password: {{PASSWORD}}' \
--header 'companyId: {{COMPANY_ID}}' \
--header 'siteId: {{SITE_ID}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "goodsRecords": [
    {
      "goods": {
        "entityCode": 6,
        "documentDate": "2016-04-12 00:00:00",
        "refDocument": 100,
        "causal": "SALE",
        "year": "2016",
        "movementDate": "2016-04-12 00:00:00",
        "currency": "EUR",
        "totalAmount": 666.00,
        "totalAmountCompany": 666.00,
        "totalAmountSite": 666.00,
        "convertionRateCompany": 1.00,
        "convertionRateSite": 1.00,
        "taxFreeNumber": null,
        "system": "ECOMMERCE",
        "startDate": null,
        "endDate": null,
        "customerCode": "12345",
        "card": null,
        "cardBarcode": null,
        "actionType": "PURCHASE",
        "actionStatus": "A",
        "result": "INTERFACE",
        "description": "insertSale"
      },
      "costs": [
        {
          "rowNumber": 1,
          "itemCode": "",
          "listPrice": 100.00,
          "salePrice": "impostarlo uguale a listPrice",
          "listPriceCompany": 100.00,
          "listPriceSite": 100.00,
          "discountValueSite": 33.00,
          "convertionRateCompany": 1.00,
          "convertionRateSite": 1.00,
          "taxRate": 0.22
        }
      ],
      "payments": [
        {
          "paymentType": "Credit",
          "paymentValue": 600.00
        }
      ]
    }
  ]
}'

Responses

🟢200Success

application/json

Body

Example

{}

🟠422Unique constraint error

Modified at 2024-08-14 15:33:36

Insert/Update deposits

Delete services