API resource list of payments

Use the payment list endpoint the following way:

Payment List

  1. Get all payments not processed since a given date.
  2. Process the payments within your software
  3. Mark the payments as processed.

Step 1: Get all payments not processed since a given date.

GET https://service.runmyaccounts.com/api/{version}/clients/{clientname}/invoices/payment_list?processed=yyyy-MM-ddTHH:mm

See invoice payment entity.

Parameter Description default 
processed Payment transactions that have not been processed after a certain time stamp (For­mat yyyy-MM-ddTHH:mm„)

Step 2: Process the payments within your software

Your piece of cake

Step 3: Mark the payments as processed

POST https://service.runmyaccounts.com/api/{version}/clients/{mandantenname}/invoices/set_as_processed

Content-Type: application/x-www-form-urlencoded

Parameter Description Default
id Id of payment that should be marked as processed

You can mark multiple payments by simply adding multiple id parameters.

Example

https://service.runmyaccounts.com/api/latest/clients/apitest/invoices/payment_list?processed=2011-08-01T23:59&api_key=d1bvbxkI8f1bnMBJ4sZiC-xupl4fOEzf

Important Notes on ‚flag‘ and ‚processed‘

  • the payment flag is based on the api-key/pat if you change it all flags will be based on the new api-key/pat (if new – then all flag will have a status ‚NEW‘)
  • the processed is based as well on api-key/pat if you change it it will be based on given api-key (which is used to call set_as_processed) – if new api-key/pat then there is no processed payments for that api-key/pat
  • if you need to transfer history of the api-key/pat from old to new one – please contact support
War dieser Artikel hilfreich?
Dislike 0
Ansichten: 712
Nach oben scrollen