►  Read Payment

curl –H  'X-api_key: {value}'  http://companyid.seasoo.net/api/Payment/105

-> Return one JSON object of payment.

►  Query Payment

curl –H  'X-api_key: {value}'  http://companyid.seasoo.net/api/Payment?invoiceId=='402881cd2ffd95a8012ffdeeb25d0005'

-> Return array of JSON object of payment, which belong to invoice with id = '402881cd2ffd95a8012ffdeeb25d0005'.

invoiceid is filter-parameter. Following filter-parameters are supported:

Parameter

Type

Description

invoiceId

String

Id of invoice, which this payment belongs to.

clientName

String

Name of client, who pays for this payment.

invoiceNumber

String

Number of invoice, which this payment belongs to.

date

Datetime

Date when this payment is done.

amount

Double

 

currency

String

ISO-currency code e.g. "EUR","USD"

method

String

Which method is used for this payment? E.g. Cash, Bank Transfer etc.

note

String

 

►  Insert Payment

POST/PUT   http://companyid.seasoo.net/api/Payment

with api_key and following request body:

{"invoiceId":"402881cd2ffd95a8012ffdeeb25d0005",

  "clientName":"Bosh GmbH",

  "invoiceNumber":"INV0001",

  "date":"2010-09-07",

  "amount":20000,

  "currency":"EUR",

  "method":"Cash"

}

-> Response has http status code = 201 if successfully. Otherwise it returns status code 500.

►  Update Payment

Like insert payment, only URL is different:

POST/PUT http://companyid.seasoo.net/api/Payment/{id}

with request body is JSON content of payment.

►  Delete Payment

DELETE http://companyid.seasoo.net/api/Payment/{id}

-> Response has status code = 204 in case of success and 404 in case of not success.