The phrase indicates leaving something undone, in order to do something else.
Using the rent money to pay the phone bill, not going to visit your mother, so that you can spend time with your SO, giving a gift you bought for a friend to your sister, when you suddenly remember her birthday, are all examples of "robbing Peter to pay Paul"
The intimation is that you should really be doing both things, not only one.