Payment history [ccb by dsb®

Payment history

based on subscription order number

Webservice returned paymenthistory of subsbsriptionorder specified by order number.

Path mapping(internal): /net/dsb/avs3/Archive/getPaymentHistory-1.0.0
Fuba: /DSB/_ISM_E_GET_PAYHISTORY

URL

GET: /rest/{client}/subscriptions/{orderNumber}/payments

Parameter	Description
client	client id
orderNumber	subscription order number
invoiceHistory	Only for non-Renewal Subscriptions

JSON Result

The response is a JSON document containing a history elements.

Example

{
  "orderNumber":"4000292229",
  "history":  [
    {
      "date":"22.01.2014",
      "archiveId":"52",
      "amount":"371.73",
      "invoiceNumber":"5000622879",
      "externalDocumentNumber":"",
      "currency":"GBP",
      "position":3,
      "cycle":1,
      "documentId":""
    },
    {
      "date":"21.01.2016",
      "archiveId":"52",
      "amount":"420.00",
      "invoiceNumber":"5001533519",
      "externalDocumentNumber":"2500153351901",
      "currency":"GBP",
      "position":5,
      "cycle":1,
      "documentId":"00000000000000658_1110_2500153351901_000"
    }
  ]
}

Field name	Type	Description
orderNumber	C	Subscription no.
archiveId	C	Archive ID
date	D	Date of faktura
amount	C	Invoice amount
currency	C	Invoice currency
invoiceNumber	C	Invoice number
externalDocumentNumber	C	Document number
position	N	Position
cycle	C	Cycle
documentId	C	Document ID within the archive

Payment history

Based on the Businesspartner Number

(Use only with appropriate ccb Suite backend integration)
Returns the payment history related to the specified Bp number.

The closing balance has to be cumulated using the accountBalance fields of the accountBalances array.

Path mapping(internal): /net/dsb/avs3/Archive/getPaymentHistoryforBp-1.0.0
Fuba: /DSB/_ISM_E_GET_PAYHISTORY

URL

GET: /rest/{client}/bp/{bpNumber}/payments?sp={sp}&so={so}

Parameter	Type/Length	Description
client	C/3	client id
bpNumber	C/10	Businesspartner number
sp	C/3	service provider. (mandatory, if the user account can use different service provider values)
so	C/4	sales organization. (mandatory if the user account is only allowed to read some sales orgas of the client)

JSON Result

The response is a JSON document containing accountBalances and history elements.
You have to cumulate the single accountBalance entries to get the enclosing balance result.

Example

{
  "accountBalances“ : [
    {
    "contractAccountNumber" : "4000292229",
    "accountBalance“ : "19.95"
    },
    {
    " contractAccountNumber " : "4000242229",
    "accountBalance“ : "19.95"
    },
    ...
  ],
  "history": [
    {
    "orderNumber":"4000292229",
    "date":"22.02.2014",
    "archiveId":"52",
    "amount":"371.73",
    "invoiceNumber":"5000622879",
    "externalDocumentNumber":"",
    "currency":"EUR",
    "position":3,
    "cycle" : ""
    "documentId":"00000000000000658_1110_2700153351901_000"
    },
    {
    "orderNumber":"4000242229",
    "date":"22.01.2014",
    "archiveId":"52",
    "amount":"420.00",
    "invoiceNumber":"5001533519",
    "externalDocumentNumber":"2500153351901",
    "currency":"EUR",
    "position":5,
    "cycle" : ""
    "documentId":"00000000000000658_1110_2500153351901_000"
    },
    ...
  ]
}

Field name	Type	Description
accountBalance	C	Account balance for one contractAccountNumber
contractAccountNumber	C	Contract Account Number
orderNumber	C	Subscription no.
archiveId	C	Archive ID
date	D	Date of faktura
amount	C	Invoice amount
currency	C	Invoice currency
invoiceNumber	C	Invoice number
externalDocumentNumber	C	Document number
position	N	Position
cycle	C	Cycle
documentId	C	Document ID within the archive

HTTP Response State	Description
200	Success
401	Authorization failed
403	Access to Subscription forbidden
404	Subscription not found