(Quick Reference)

60 Prepayments - Reference Documentation

Version: 2.1

60.1List

60.2Show

60.3Create

60.4Update

60.5Delete

60.6Upsert

60 Prepayments

60.1 List

Service: List prepayments

Description: This web service returns a json list of prepayments.

URL:

https://BASE_URL/api/VERSION/orderPrepayments

Method: GET

Parameters:

Pagination parameters:

Name	Description	Type	Required	Possible values
max	Limits the number of resources requested to return.	Integer	no
offset	Tells where to start returning records from the entire set of results.	Integer	no
order	Orders ascending or descending.	Integer	no	asc,desc
sort	Orders the results by the specified field.	String	no

The max parameter is set to 100 by default.

Filters parameters:

Name	Description	Type	Required	Example values
dateCreated_gt	Filters by the resource's creation date time and operator greater than	Date	no	2016-08-15T14:52:48Z
dateCreated_gte	Filters by the resource's creation date time and operator greater than or equal	Date	no
dateCreated_lt	Filters by the resource's creation date time and operator less than	Date	no
dateCreated_lte	Filters by the resource's creation date time and operator less than or equal	Date	no
lastUpdated_gt	Filters by the resource's last-modified date time and operator greater than	Date	no
lastUpdated_gte	Filters by the resource's last-modified date time and operator greater than or equal	Date	no
lastUpdated_lt	Filters by the resource's last-modified date time and operator less than	Date	no
lastUpdated_lte	Filters by the resource's last-modified date time and operator less than or equal	Date	no
paymentDate_gt	Filters by the resource's payment date time and operator greater than	Date	no	2016-08-15T14:52:48Z
paymentDate_gte	Filters by the resource's payment date time and operator greater than or equal	Date	no
paymentDate_lt	Filters by the resource's payment date time and operator less than	Date	no
paymentDate_lte	Filters by the resource's payment date time and operator less than or equal	Date	no
reference	Wildcard search by the resource's reference	String	no
customerReference	Wildcard search by the resource's customer reference	String	no	customerReference=Ref-6* , customerReference=ef-6 , customerReference=ef-6*

Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)

Success Output

Success case: response.status=200

{
  "paging": {
    "total": 702,
    "max": 5,
    "offset": 5,
    "previous": "/api/v1.0/orderPrepayments?sort=dateCreated&max=5&order=ascoffset=0",
    "next": "/api/v1.0/orderPrepayments?sort=dateCreated&max=5&order=asc&offset=10"
  },
  "data": [
      {
       "id": 27,
       "reference": "L-aa-1505226514088",
        "description": "",
        "total": 45,
        "paymentDate": "2017-09-12T08:25:00Z",
        "dateCreated": "2017-09-12T14:28:49Z",
        "lastUpdated": "2017-09-12T14:28:49Z",
        "status": "UNAPPLIED",
        "currency": "AUD",
        "paymentType": {
          "id": 4,
          "reference": "CASH",
          "name": "Cash",
          "href": "/valomniav2/api/v2.1/paymentTypes/4"
        },
        "bank": null,
        "chequeNumber": null,
        "desiredPaymentDate": null,
        "organization": "entity1",
        "createdBy": {
          "userId": 2,
          "reference": "emp-002",
          "href": "/valomniav2/api/v2.1/users/2"
        },
        "customer": {
          "id": 1,
          "reference": "JohnDoe",
          "reference2": "",
          "name": "John Doe",
          "href": "/valomniav2/api/v2.1/customers/1"
        }
      },…
  ]
}

Failure Output

Failure case:response.status = 400

{
  "error": "invalid_param",
  "error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}

{
    "error": "invalid_datetime_format",
    "error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016-08-1Z]"
}

Failure case:response.status = 500

{
   "error": "server_error",
   "error_description": "Oops! Something went wrong..."
}

60.2 Show

Service: Show a prepayment

Description: Returns the requested operation in json format when successful. Returns a json response, describing the failure condition when unsuccessful.

URL:

https://BASE_URL/api/VERSION/orderPrepayments/{id}

URL with external_id:

https://BASE_URL/api/VERSION/orderPrepayments/reference/{id}

Method: GET

Parameters:

Name	Description	Type	Required	Example values
id	The ID of the desired prepayment	Long/String	yes	123

Success Output

Success case: response.status = 200

{
 "id": 27,
 "reference": "L-aa-1505226514088",
  "description": "",
  "total": 45,
  "paymentDate": "2017-09-12T08:25:00Z",
  "dateCreated": "2017-09-12T14:28:49Z",
  "lastUpdated": "2017-09-12T14:28:49Z",
  "status": "UNAPPLIED",
  "currency": "AUD",
  "paymentType": {
    "id": 4,
    "reference": "CASH",
    "name": "Cash",
    "href": "/valomniav2/api/v2.1/paymentTypes/4"
  },
  "bank": null,
  "chequeNumber": null,
  "desiredPaymentDate": null,
  "organization": "entity1",
  "createdBy": {
    "userId": 2,
    "reference": "emp-002",
    "href": "/valomniav2/api/v2.1/users/2"
  },
  "customer": {
    "id": 1,
    "reference": "JohnDoe",
    "reference2": "",
    "name": "John Doe",
    "href": "/valomniav2/api/v2.1/customers/1"
  }
}

Failure Output

Failure case:response.status = 400

{
  "error": "invalid_param_type",
  "error_description": "The type of parameter id you provided is not valid for this request."
}

Failure case:response.status = 404

{
  "error": "not_found",
  "error_description": "The order with the id 7065 doesn't exist."
}

60.3 Create

Service: Create a prepayment

Description: Returns the created prepayment in json format when successful. Returns a json response, describing the failure condition when unsuccessful.

URL:

https://BASE_URL/api/VERSION/orderPrepayments

Method: POST

Request content type: application/json

Parameters:

Name	Description	Type	Required	Example values
reference		String	yes
customerId	The numerical ID of customer	Long/String	yes
userId	The numerical ID of user. By default, it is set to the current connected user	Long/String	no
total		Double	yes
currency	ISO code of configured currency. By default, it is set as the organization currency if the customer does not have currency.	String	no	EUR
latitude		Double	No	12.914
longitude		Double	No	14.99
checkInDate		String	No	2016-04-12T19:30:48Z
paymentDate		Date	Yes	2016-08-15T14:52:48Z
paymentTypeId	The ID of payment type	Integer/String	No
desiredPaymentDate	Used when payment is by CHEQUE	Date	no	2016-08-15
bank	The bank name. It's used when payment is by CHEQUE	String	No
useExternalId	By default, it is set to false. set it to true if you want to use external ids.	Boolean	no	true , false

latitude and longitude must have a valid value otherwise, they will be considered as null

Success Output

Success case: response.status=201

{
 "id": 27,
 "reference": "L-aa-1505226514088",
  "description": "",
  "total": 45,
  "paymentDate": "2017-09-12T08:25:00Z",
  "dateCreated": "2017-09-12T14:28:49Z",
  "lastUpdated": "2017-09-12T14:28:49Z",
  "status": "UNAPPLIED",
  "currency": "AUD",
  "paymentType": {
    "id": 4,
    "reference": "CASH",
    "name": "Cash",
    "href": "/valomniav2/api/v2.1/paymentTypes/4"
  },
  "bank": null,
  "chequeNumber": null,
  "desiredPaymentDate": null,
  "organization": "entity1",
  "createdBy": {
    "userId": 2,
    "reference": "emp-002",
    "href": "/valomniav2/api/v2.1/users/2"
  },
  "customer": {
    "id": 1,
    "reference": "JohnDoe",
    "reference2": "",
    "name": "John Doe",
    "href": "/valomniav2/api/v2.1/customers/1"
  }
}

Failure Output

Failure case:response.status = 400

{
  "error": "save_failed",
  "error_description": "Failed to save instance."
}

{
  "error": "not_unique",
  "error_description": "reference already used"
}

{
  "error": "invalid_param_type",
  "error_description": "An invalid value was specified for parameter: total (must be positive)"
}

{
  "error": "date_validation_error",
  "error_description": "Failed to add the Prepayment with the reference PR_001 : paymentDate incorrect Date Format"
}

{
  "error": "not_found",
  "error_description": "The Customer with the id 10 doesn't exist."
}

{
  "error": "not_found",
  "error_description": "The payment type with the id 8000 doesn't exist."
}

{
  "error": "not_found",
  "error_description": "The User with the id 1 doesn't exist."
}

{
  "error": "not_found",
  "error_description": "The currency with name IN doesn't exist."
}

Failure case:response.status = 500

{
   "error": "server_error",
   "error_description": "Oops! Something went wrong..."
}

60.4 Update

Service: Update a prepayment

Description: Returns the updated prepayment in json format when successful. Returns a json response, describing the failure condition when unsuccessful.

URL:

https://BASE_URL/api/VERSION/orderPrepayments/{id}

URL with external_id:

https://BASE_URL/api/VERSION/orderPrepayments/reference/{id}

Method: PUT

Request content type: application/json

Parameters:

Name	Description	Type	Required	Example values
id	The ID of the desired prepayment	Long/String	yes	123
reference		String	yes
customerId	The numerical ID of customer	Long/String	yes
userId	The numerical ID of user. By default, it is set to the current connected user	Long/String	no
total		Double	yes
currency	ISO code of configured currency. By default, it is set as the organization currency if the customer does not have currency.	String	no	EUR
latitude		Double	No	12.914
longitude		Double	No	14.99
checkInDate		String	No	2016-04-12T19:30:48Z
paymentDate		Date	Yes	2016-08-15T14:52:48Z
paymentTypeId	The ID of payment type	Integer/String	No
desiredPaymentDate	Used when payment is by CHEQUE	Date	no	2016-08-15
bank	The bank name. It's used when payment is by CHEQUE	String	no

Success Output

Success case: response.status=200

{
 "id": 27,
 "reference": "L-aa-1505226514088",
  "description": "",
  "total": 45,
  "paymentDate": "2017-09-12T08:25:00Z",
  "dateCreated": "2017-09-12T14:28:49Z",
  "lastUpdated": "2017-09-12T14:28:49Z",
  "status": "UNAPPLIED",
  "currency": "AUD",
  "paymentType": {
    "id": 4,
    "reference": "CASH",
    "name": "Cash",
    "href": "/valomniav2/api/v2.1/paymentTypes/4"
  },
  "bank": null,
  "chequeNumber": null,
  "desiredPaymentDate": null,
  "organization": "entity1",
  "createdBy": {
    "userId": 2,
    "reference": "emp-002",
    "href": "/valomniav2/api/v2.1/users/2"
  },
  "customer": {
    "id": 1,
    "reference": "JohnDoe",
    "reference2": "",
    "name": "John Doe",
    "href": "/valomniav2/api/v2.1/customers/1"
  }
}

Failure Output

Failure case:response.status = 400

{
  "error": "invalid_param_type",
  "error_description": "An invalid value was specified for parameter: total (must be positive)"
}

{
  "error": "date_validation_error",
  "error_description": "Failed to update the Prepayment with the reference PR_001 : paymentDate incorrect Date Format"
}

Failure case:response.status = 404

{
  "error": "not_found",
  "error_description": "The prepayment with the id 5 doesn't exist."
}

{
  "error": "not_found",
  "error_description": "The payment type with the id 8000 doesn't exist."
}

60.5 Delete

Service: Delete a prepayment

Description: Returns a JSON response.

URL:

https://BASE_URL/api/VERSION/orderPrepayments/{id}

URL with external_id:

https://BASE_URL/api/VERSION/orderPrepayments/reference/{id}

Method: DELETE

Parameters:

Name	Description	Type	Required	Example values
id	The ID of the desired prepayment	Long/String	yes	123

Success Output

Success case: response.status=200

{
  "success": "true",
  "success_description": "Instance deleted successfully"
}

Failure Output

Failure case:response.status = 400

{
  "error": "delete_failed",
  "error_description": "Failed to delete instance."
}

{
  "error":"invalid_param_type",
  "error_description": "The type of parameter id you provided is not valid for this request."
}

Failure case:response.status = 404

{
  "error": "not_found",
  "error_description": "The prepayment with the id 706 doesn't exist."
}

Failure case:response.status = 500

{
  "error": "server_error",
  "error_description": "Oops! Something went wrong..."
}

60.6 Upsert

Service: Upsert a prepayment

Description: This web service is used to insert a prepayment to the database if it does not already exist, or update it.

URL:

https://BASE_URL/api/VERSION/orderPrepayments/reference/{id}

Method: POST

Request content type: application/json

Parameters:

Name	Description	Type	Required	Example values
customerId	The numerical ID of customer	Long/String	yes
userId	The numerical ID of user. By default, it is set to the current connected user	Long/String	no
total		Double	yes
currency	ISO code of configured currency. By default, it is set as the organization currency if the customer does not have currency.	String	no	EUR
latitude		Double	No	12.914
longitude		Double	No	14.99
checkInDate		String	No	2016-04-12T19:30:48Z
paymentDate		Date	Yes	2016-08-15T14:52:48Z
paymentTypeId	The ID of payment type	Integer/String	No
desiredPaymentDate	Used when payment is by CHEQUE	Date	no	2016-08-15
bank	The bank name. It's used when payment is by CHEQUE	String	no

Success Output

Success case: response.status=201

{
 "id": 27,
 "reference": "L-aa-1505226514088",
  "description": "",
  "total": 45,
  "paymentDate": "2017-09-12T08:25:00Z",
  "dateCreated": "2017-09-12T14:28:49Z",
  "lastUpdated": "2017-09-12T14:28:49Z",
  "status": "UNAPPLIED",
  "currency": "AUD",
  "paymentType": {
    "id": 4,
    "reference": "CASH",
    "name": "Cash",
    "href": "/valomniav2/api/v2.1/paymentTypes/4"
  },
  "bank": null,
  "chequeNumber": null,
  "desiredPaymentDate": null,
  "organization": "entity1",
  "createdBy": {
    "userId": 2,
    "reference": "emp-002",
    "href": "/valomniav2/api/v2.1/users/2"
  },
  "customer": {
    "id": 1,
    "reference": "JohnDoe",
    "reference2": "",
    "name": "John Doe",
    "href": "/valomniav2/api/v2.1/customers/1"
  }
}

Failure Output

Failure case:response.status = 400

{
  	"error": "save_failed",
  	"error_description": "Failed to save instance."
}

Failure case:response.status = 404

{
	"error":"not_found",
 	"error_description": "The payment type with the id 999 doesn't exist."
}

Failure case:response.status = 500

{
	"error": "server_error",
	"error_description": "Oops! Something went wrong..."
}

<< 59Payments operations

61Prepayment Allocations >>

60 Prepayments - Reference Documentation

Table of Contents

60 Prepayments

60.1 List

Success Output

Failure Output

60.2 Show

Success Output

Failure Output

60.3 Create

Success Output

Failure Output

60.4 Update

Success Output

Failure Output

60.5 Delete

Success Output

Failure Output

60.6 Upsert

Success Output

Failure Output

Answers

Appointment

Appointment Categories

Attribute values

Attributes

Authentication

Authority

Check In List

Contacts

Customer Categories

Customer Categories Discount Lists

Customer Categories Price Lists

Customer Categories Tax Lists

Customer Discounts

Customer Employee

Customer Group Promotion Lists

Customer Groups

Customer Groups Assign

Customer Price List

Customer Promo List

Customer Segmentations

Customer Tax List

Customers

Deliveries

Discount lists

Employee Groups

Employee Item Category Assign

Employee WareHouses

Employees

Exchange rates

Item Categories

Item Groups

Item Groups Assign

Item attributes

Item category translation

Item customer groups assign

Item group translation

Item translation

Item units

Items

Loading details

Loadings

Objectives

Operation Prepayments

Operation lines

Operation payments

Operations

Payment types

Prepayment Allocations

Price List

Prices

Promotion inputs

Promotion outputs

Promotions

Question Columns

Question Lines

Question options

Questions

Reasons