Table of Contents

maxLevel	2

...

Name

Type

Description

token

String

The token retrieved from the login method

payment_identifier

(mandatory)

Payment identifier

The identifier of the payment that should be returned as a result. The allowed payment identifier fields are the following:

Include Page

	V4:payment_identifier
	V4:payment_identifier

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier

The identifier of the accounts receivable in which the payments that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

type_identifier

(optional)

Financial transaction type identifier

The financial transaction type of the payment that should be returned as a result. The allowed financial transaction type identifier field are the following:

Include Page

	V4:financial_transaction_type_identifier
	V4:financial_transaction_type_identifier

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:

Include Page

	V4:financial_transaction_category_identifier
	V4:financial_transaction_category_identifier

payment_method_identifier

(optional)

Payment method identifier

The payment method of the payment that should be returned as a result. The allowed payment method identifier fields are the following:

Include Page

	V4:payment_method_identifier
	V4:payment_method_identifier

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier

The identifier of the accounts receivable in which the payments that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

type_identifier

(optional)

Financial transaction type identifier

The financial transaction type of the payment that should be returned as a result. The allowed financial transaction type identifier field are the following:

Include Page

	V4:financial_transaction_type_identifier
	V4:financial_transaction_type_identifier

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:

Include Page

	V4:financial_transaction_category_identifier
	V4:financial_transaction_category_identifier

payment_method_identifier

(optional)

Payment method identifier

The payment method of the payment that should be returned as a result. The allowed payment method identifier fields are the following:

Include Page

	V4:payment_method_identifier
	V4:payment_method_identifier

number

(mandatory)

Number

The number of payments to be retrieved, starting from the latest one

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier

The identifier of the accounts receivable in which the payment should be allocated to. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

type_identifier

(mandatory)

Financial transaction type identifier

The financial transaction type of the payment. The allowed financial transaction type identifier field are the following:

Include Page

	V4:financial_transaction_type_identifier
	V4:financial_transaction_type_identifier

life_cycle_state

(mandatory)

String

The state of the retrieved payment which can be one of the following:

DRAFT, POSTED

payment_method_identifier

(mandatory)

Payment method identifier

The payment method of the payment. The allowed payment method identifier fields are the following:

Include Page

	V4:payment_method_identifier
	V4:payment_method_identifier

payment_amount

(mandatory)

Number

The amount of the payment

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:

Include Page

	V4:financial_transaction_category_identifier
	V4:financial_transaction_category_identifier

received_on

(optional)

Date

The date that the payment was received. It defaults to the issued date if not specified

received_by_user_identifier

(optional)

User identifier

The user who actually received the payment. It defaults to the issued by user if not specified. The allowed user identifier fields are the following:

Include Page

	V4:user_identifier
	V4:user_identifier

received_by_unit_identifier

(optional)

Unit identifier

The unit who actually received the payment. The allowed unit identifier fields are the following:

Include Page

	V4:unit_identifier
	V4:unit_identifier

notes

(optional)

String

Shared notes for the payment

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

invoices_to_pay_set

(optional)

Set of invoice objects

The invoices that are intended to be paid

bills_to_pay_set

(optional)

Set of bill objects

The bills that are intended to be paid

...

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    	"token": "34B52059BCC99490C01E24A4B1C57BFCB8D7A12E9F91AFADE914B7330AFD08CB",
    	"accounts_receivable_identifier":{
        "number":"9186"
    },
    	"type_identifier":{
        "name":"Invoices Balance Payment 2"
    },
    	"life_cycle_state":"DRAFTPOSTED",
    	"payment_method_identifier":{
        "name":"Direct Debit"
    },
    "	"payment_amount":300,
    "category_identifier":{
        "name":"Payment Categories"
    },
    "50",
	"received_on":"2014-04-19T09:12:54",
    	"received_by_user_identifier":{
        "id"username":"40928D9B96FE6CB963D2DD8955814774mpadministrator"
    },
    	"received_by_unit_identifier":{"name":"Admin Unit"},
	"invoices_to_pay_set": [
	{
	    "id"invoice_identifier":{"reference_number":"C4370788B2630BC8A99E8C7397406C09307"
    },
    "invoices},
	}],
	"bills_to_pay_set": [
    {
	   "bill_identifier":{"number":"126"},
       	}]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "invoice_identifierstatus":{
       {
        "idmessage":"85748C51BB97C48E47050CDC811FB42B" null,
        "description": null,
 }       "code": "OK"
}     ]},
    "bills_to_pay_setdata":[
   
    {
   
        "billpayment_identifieramount":{
        50,
        "numberissued_on":"000018" "2014-07-14T16:29:02",
            }
        }
    ]
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "status":{"life_cycle_state": "POSTED",
        "messagenumber":null,
        "description99":null,
        "codeid": "OKC5E2F4D14F217257AD1A724E9B2F77F2"
,
   },     "datareference_number":{
        "payment_amount114":300,
        "issuedposted_on": "2014-0507-21T1614T16:1229:2902",
        "life_cycle_state":"DRAFT",
        "number":null,
        "id":"7C5B8E9E5A8D1733EBFE75D89C10D8FC",
        "reference_number":"24",
        "posted_on":null
    }
}

POST payments/pay_invoice

...

}
}

POST payments/pay_invoice

This method is creating a new payment with the intention to pay the whole outstanding amount of a specific invoice. The method can be applied on a single invoice only. The payment is created in a posted state

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier

The identifier of the accounts receivable in which the payment should be allocated to. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

type_identifier

(mandatory)

Financial transaction type identifier

The financial transaction type of the payment. The allowed financial transaction type identifier field are the following:

Include Page

	V4:financial_transaction_type_identifier
	V4:financial_transaction_type_identifier

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:

Include Page

	V4:financial_transaction_category_identifier
	V4:financial_transaction_category_identifier

payment_method_identifier

(mandatory)

Payment method identifier

The payment method of the payment. The allowed payment method identifier fields are the following:

Include Page

	V4:payment_method_identifier
	V4:payment_method_identifier

invoice_identifier

(mandatory)

Invoice identifier

The invoice to be paid. The allowed invoice identifier fields are the following:

Include Page

	V4:invoice_identifier
	V4:invoice_identifier

received_on

(optional)

Date

The date that the payment was received. It defaults to the issued date if not specified

received_by_user_identifier

(optional)

User identifier

The user who actually received the payment. It defaults to the issued by user if not specified. The allowed user identifier fields are the following:

Include Page

	V4:user_identifier
	V4:user_identifier

received_by_unit_identifier

(optional)

Unit identifier

The unit who actually received the payment. The allowed unit identifier fields are the following:

Include Page

	V4:unit_identifier
	V4:unit_identifier

notes

(optional)

String

Shared notes for the payment

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

...

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    	"token": "34B52059BCC99490C01E24A4B1C57BFCB8D7A12E9F91AFADE914B7330AFD08CB",
    	"accounts_receivable_identifier":{
        "number":"9192"
    },
    	"life_cycle_state":"POSTED",
	"type_identifier":{
        "name":"Invoices Balance Payment 2"
    },
    "life_cycle_state":"DRAFT",
    "	"payment_method_identifier":{
        "name":"Direct Debit"
    },
    "payment_amount":300,
    "category	"category_identifier":{"name":"Invoice Payments"},
	"invoice_identifier":{
        "name"reference_number":"Payment Categories"
    328"},
    	"received_on":"2014-0407-19T0914T09:12:54",
    	"received_by_user_identifier":{
        "id"username":"40928D9B96FE6CB963D2DD8955814774JackH"
    },
    	"received_by_unit_identifier":{
        "id"name":"C4370788B2630BC8A99E8C7397406C09"
    Admin Unit"},
   
"invoice_identifier":{
        "id":"85748C51BB97C48E47050CDC811FB42B"
    }
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "payment_amount":300 225,
        "issued_on": "2014-0507-21T1614T16:1849:0511",
        "life_cycle_state": "POSTED",
        "number": "31100",
        "id": "655241C5E09AAB51DB296E0194FBBD0883DFE781350877933A6FA2A51EF0F102",
        "reference_number": "25115",
        "posted_on": "2014-0507-21T1614T16:1849:4111"
    }
}

POST payments/pay_bill

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier

The identifier of the accounts receivable in which the payment should be allocated to. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

type_identifier

(mandatory)

Financial transaction type identifier

The financial transaction type of the payment. The allowed financial transaction type identifier field are the following:

Include Page

	V4:financial_transaction_type_identifier
	V4:financial_transaction_type_identifier

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:

Include Page

	V4:financial_transaction_category_identifier
	V4:financial_transaction_category_identifier

payment_method_identifier

(mandatory)

Payment method identifier

The payment method of the payment. The allowed payment method identifier fields are the following:

Include Page

	V4:payment_method_identifier
	V4:payment_method_identifier

bill_identifier

(mandatory)

Bill identifier

The invoice to be paid. The allowed invoice identifier fields are the following:

Include Page

	V4:bill_identifier
	V4:bill_identifier

received_on

(optional)

Date

The date that the payment was received. It defaults to the issued date if not specified

received_by_user_identifier

(optional)

User identifier

The user who actually received the payment. It defaults to the issued by user if not specified. The allowed user identifier fields are the following:

Include Page

	V4:user_identifier
	V4:user_identifier

received_by_unit_identifier

(optional)

Unit identifier

The unit who actually received the payment. The allowed unit identifier fields are the following:

Include Page

	V4:unit_identifier
	V4:unit_identifier

notes

(optional)

String

Shared notes for the payment

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

...

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    	"token": "34B52059BCC99490C01E24A4B1C57BFCB8D7A12E9F91AFADE914B7330AFD08CB",
    	"accounts_receivable_identifier":{
        "number":"9186"
    },
    	"life_cycle_state":"POSTED",
	"type_identifier":{
        "name":"Invoices Balance Payment 2"
    },
    "life_cycle_state":"DRAFT",
    	"payment_method_identifier":{
        "name":"Direct Debit"
    },
    "payment_amount":300,
    "category	"category_identifier":{"name":"Bill Payments"},
	"bill_identifier":{
        "name"number":"Payment Categories"
    128"},
    	"received_on":"2014-0407-19T0914T09:12:54",
    	"received_by_user_identifier":{
        "id"username":"40928D9B96FE6CB963D2DD8955814774JackH"
    },
    	"received_by_unit_identifier":{
        "id"name":"C4370788B2630BC8A99E8C7397406C09"
    },
    "bill_identifier":{
        "number":"000018"
    }Admin Unit"},
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "status":":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "payment_amount":300 100,
        "issued_on": "2014-0507-21T1614T17:2301:2943",
        "life_cycle_state": "POSTED",
        "number": "32101",
        "id": "A597C0D695D7AA6740735842FF593614B88388BA9E05BCBBB4579A2D2EBB22DC",
        "reference_number": "26116",
        "posted_on": "2014-0507-21T1614T17:2301:5544"
    }
}

POST payments/post

This method is used to post a payment which is in draft state.

...

Name

Type

Description

token

String

The token retrieved from the login method

payment_identifier

(mandatory)

Payment identifier

The identifier of the payment that should be posted. Only payments in draft state can be specified.The allowed payment identifier fields are the following:

Include Page

	V4:payment_identifier
	V4:payment_identifier

...

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    	"token": "34B52059BCC99490C01E24A4B1C57BFCB8D7A12E9F91AFADE914B7330AFD08CB",
    	"payment_identifier":{
        "id"reference_number":"1977CD26383EF606531BA5CE912871EE117"
    },
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "payment_amount":300 50,
        "issued_on": "2014-0507-21T1314T17:1706:5114",
        "life_cycle_state": "POSTED",
        "number": "33102",
        "id": "1977CD26383EF606531BA5CE912871EE4653BEFC9239043011096B329DFEF3F7",
        "reference_number": "15117",
        "posted_on": "2014-0507-21T1614T17:4707:1413"
    }
}

POST payments/reject

...

Name

Type

Description

token

String

The token retrieved from the login method

payment_identifier

(mandatory)

Payment Identifier

The identifier of the payment that should be posted. Only payments in draft state can be specified.The allowed payment identifier fields are the following:

Include Page

	V4:payment_identifier
	V4:payment_identifier

rejection_reason_identifier

Rejection reason identifier

The reason that the payment is rejected. The allowed rejection reason identifier fields are the following:

Include Page

	V4:financial_transaction_rejection_reason_identifier
	V4:financial_transaction_rejection_reason_identifier

...

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    	"token": "34B52059BCC99490C01E24A4B1C57BFCB8D7A12E9F91AFADE914B7330AFD08CB",
    	"payment_identifier":{
        "id"reference_number":"8BD84282F4A9B5B0A61F0030F70D9AE1118"
    },
    	"rejection_reason_identifier":{
        "name":"test"Reject Due to Business  Request"},
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "payment_amount":300 50,
        "issued_on": "2014-0507-21T1514T17:2606:3528",
        "life_cycle_state": "REJECTED",
        "number": null,
        "id": "8BD84282F4A9B5B0A61F0030F70D9AE10ACCC72477BA606EE3B409400069F1BB",
        "reference_number": "16118",
        "posted_on": null
    }
}

POST payments/cancel

...

Name

Type

Description

token

String

The token retrieved from the login method

payment_identifier

(mandatory)

Payment Identifier

The identifier of the payment that should be posted. Only payments in draft state can be specified.The allowed payment identifier fields are the following:

Include Page

	V4:payment_identifier
	V4:payment_identifier

type_identifier

(mandatory)

Financial transaction type identifier

The financial transaction type of the payment cancellation. The allowed financial transaction type identifier field are the following:

Include Page

	V4:financial_transaction_type_identifier
	V4:financial_transaction_type_identifier

category_identifier

(optional)

Financial transaction category identifier

The financial transaction category of the payment cancellation. The allowed financial transaction category identifier fields are the following:

Include Page

	V4:financial_transaction_category_identifier
	V4:financial_transaction_category_identifier

notes

(optional)

String

Shared notes for the payment

issue_reason

(optional)

String

A description of the reason that the payment cancellation is issued

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

...

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    	"token": "BFE676C8B1D41817417109413D8AB68EB8D7A12E9F91AFADE914B7330AFD08CB",
    	"payment_identifier":{
        "id":"672B4661967A3B1AF6BCBC23CCDEE07D"
    },
    "type"reference_number":"117"},
	"type_identifier":{"name":"Payment Cancellation"},
	"category_identifier":{
        "id"name":"094D8FE66ED969DABF5FF5749A9F7BD0"Cancellation Because of   Mistake"},
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "payment":
        {
            "payment_amount":300 50,
            "issued_on": "2014-0507-21T1614T17:0006:0714",
            "life_cycle_state": "POSTED",
            "number": "30102",
            "id": "672B4661967A3B1AF6BCBC23CCDEE07D4653BEFC9239043011096B329DFEF3F7",
            "reference_number": "23117",
            "posted_on": "2014-0507-21T1614T17:0007:3713"
        },
        "payment_cancellation":
        {
            "payment_amount":300 50,
            "issued_on": "2014-0507-21T1814T17:1721:0906",
            "life_cycle_state": "POSTED",
            "number": "1035",
            "id": "0F9E542DEDC81640D2A65DB257002EE88F3613168562A73556CECA0FEA772AFE",
            "reference_number": "826",
            "posted_on": "2014-0507-21T1814T17:1721:1106"
        }
    }
}

Versions Compared

Old Version 18

New Version 19

Key

POST payments/pay_invoice

POST payments/pay_invoice

POST payments/pay_bill

POST payments/post

POST payments/reject

POST payments/cancel

Page Comparison

Versions Compared

Old Version 18

New Version 19

Key

POST payments/pay_invoice

POST payments/pay_invoice

POST payments/pay_bill

POST payments/post

POST payments/reject

POST payments/cancel