API Documentation

TransactionsAdd Transaction

Method: /transactions.[format]

Fields:

Name	Data Type	Description
document_id	String	Document ID
amount	Numeric	Total payment amount being applied
reference	String	Optional payment information (ie. Cash, Credit Card)
transaction_date	Date	Date this transaction was posted (YYYY-MM-DD)

Syntax:

https://[subdomain].salesbinder.com/api/2.0/transactions.json

HTTP Request Type: POST

Example JSON Data to Submit

1{
2    "transaction": {
3        "document_id": "5a1c90cc-f7c4-4698-b60e-065d17fdd567",
4        "amount": 50.00,
5        "reference": "Cash",
6        "transaction_date": "2017-11-27"
7    }
8}

Example XML Data to Submit

1<transaction>
2  <document_id>5a1c90cc-f7c4-4698-b60e-065d17fdd567</document_id>
3  <amount>50</amount>
4  <reference>Cash</reference>
5  <transaction_date>2017-11-27</transaction_date>
6</transaction>

Success:

If you have been successful in saving a new transaction, the response will return the newly created data object along with a “message” value of “Saved” as seen below.

Example JSON Returned Response

1{
2    "message": "Saved",
3    "transaction": {
4        "document_id": "5a1c90cc-f7c4-4698-b60e-065d17fdd567",
5        "amount": 50,
6        "reference": "Credit Card 9008",
7        "transaction_date": "2017-11-27T00:00:00+00:00",
8        "account_id": "4d76bc2e-b198-4bd6-95f5-7439b86a4567",
9        "created": "2017-11-27T22:27:14+00:00",
10        "modified": "2017-11-27T22:27:14+00:00",
11        "id": "75f31989-598b-43da-830d-292767bda9f1"
12    }
13}

Updated on November 27th, 2017