05. Payments

Interface

It allows you:

• • to view your payments (payments and receipts, but not for cash register!) - ordered descending by created date and document date;

• to create new one

  • if you indicate one invoice or one order, the system will generate automaticaly the payment allocation.

• to process existing one (Complete, Void, Reverse)

Prerequisites:

• API BankAcount - list

Columns that can be used as filters:

• Organization

• DocumentNo

• BPartner

• BankAccount

• TransactionDate

• LastModified

Actions can be done:

• list

• create

• update

• process: complete, void, reverse

Payments fields:

API Methods:

List:

URL: https://api.socratecloud.com/webapi/rest/payment/list/{version}?startRow={0}&endRow={100}&accessToken={access_token}

Method: GET

Return: JSON object with next format:

{

    "data": [

        {

            "Organization": "Demo SRL",

            "Created": "2014-01-31 09:32:43",

            "CreatedBy": "SuperUser",

            "Updated": "2014-02-12 08:30:42",

            "UpdatedBy": "SuperUser",

            "DocumentNo": "1000001",

            "BankAccount": "RO60BR565660SV12345",

            "Description": null,

            "DocType": "Receipt",

            "TransactionDate": "2014-01-31 00:00:00",

            "BPartner": "SPL",

            "BPartnerName": "Xavier",

            "InvoiceNo": null,

            "OrderNo": null,

            "Currency": "RON",

            "Activity": null,

            "TenderType": "Direct Deposit",

    "ChargeName": "Servicii Diverse",

            "Charge_ID": 1003945,

            "TrxOrganization": null,

            "PaymentAmount": 500,

            "DocumentStatus": "Completed",

            "DocumentAction": "Close"

        }

    ],

    "totalRows": 1

}

Create:

URL: https://api.socratecloud.com/webapi/rest/payment/create/{version}?accessToken={access_token}&DocumentNo={document_no}

Method: POST

Return: document no for success or error message (start with "ERROR: ")

{

    "Organization": "Demo SRL",

    "Created": "2014-01-31 09:32:43",

    "CreatedBy": "SuperUser",

    "Updated": "2014-02-12 08:30:42",

    "UpdatedBy": "SuperUser",

    "BankAccount": "RO60BR565660SV12345",

    "Description": null,

    "DocType": "Receipt",

    "TransactionDate": "2014-01-31 00:00:00",

    "BPartner": "SPL",

    "InvoiceNo": null,

    "OrderNo": null,

    "Currency": "RON",

    "Activity": null,

    "TenderType": "Direct Deposit",

  "ChargeName": "Servicii Diverse",

    "Charge_ID": 1003945,

    "TrxOrganization": null,

    "PaymentAmount": 500,

    "DocumentAction": "Complete"

}

Update:

URL: https://api.socratecloud.com/webapi/rest/payment/update/{version}?accessToken={access_token}&DocumentNo={document_no}

Method: POST

Return: document no for success or error message (start with "ERROR: ")

{

    "Organization": "Demo SRL",

    "Created": "2014-01-31 09:32:43",

    "CreatedBy": "SuperUser",

    "Updated": "2014-02-12 08:30:42",

    "UpdatedBy": "SuperUser",

    "BankAccount": "RO60BR565660SV12345",

    "Description": null,

    "DocType": "Receipt",

    "TransactionDate": "2014-01-31 00:00:00",

    "BPartner": "SPL",

    "InvoiceNo": null,

    "OrderNo": null,

    "Currency": "RON",

    "Activity": null,

    "TenderType": "Direct Deposit",

  "ChargeName": "Servicii Diverse",

    "Charge_ID": 1003945,

    "TrxOrganization": null,

    "PaymentAmount": 500,

    "DocumentAction": "Complete"

}

Process header:

URL:     https://api.socratecloud.com/webapi/rest/payment/process/{version}?accessToken={access_token}&DocumentNo={document_no}&DocumentAction={document_action}

Method: POST

Return: Document status for success or error message (start with "ERROR: ")